IlsMvServer
Category
Rogue Wave Views Script class (server side)
Description
This class acts as a proxy to the running dynamic view server of the application. The single instance of IlsMvServer running in the application is accessible to script functions through the global variable MvServer.
Global functions declared using the ILS_GLOBAL_FUNCTION macros are implicit methods of this class.
Synopsis
Properties
serverName
interactor
Methods
DeclObjectLabel(IlsViewed, label)
GetInstance(typeNm, id)
GetObjectFromLabel(label)
Notify()
OpenView(IlsViewed or objectLabel, viewName)
ReplyMessage(message)
ReplyWarning(message)
ReplyError(message)
UndeclObjectLabel(IlsViewed)
API
Properties
serverName
This property returns the name used to initialize the process (see
-ilsn option in class
IlsMvProcess).
interactor
This property returns the current interacting user (MvUser).
Methods
DeclObjectLabel(IlsViewed, label)
This member function associates a label with a server object and stores the association in the server.
GetInstance(typeNm, id)
This method retrieves an object instance that has been registered with identifier id in dictionary typeNm. Dynamic objects are stored in a dictionary if the useDictionary property has been set for the dynamic type.
GetObjectFromLabel(label)
This method retrieves a declared object from its label. See the corresponding C++ member function
IlsMvServer::GetObjectFromLabel.
Notify()
This method triggers a notification cycle. When callbacks are called from a component, there is no need to trigger a notification cycle as such a cycle will start after the request has been processed. This function is generally used when an Rogue Wave Script timer is fired to start a notification cycle explicitly. See
IlsMvServer::Notify.
OpenView(IlsViewed or objectLabel, viewName, param1, ..., paramn)
This method opens the dynamic view
viewName on the object passed as the first parameter (either an
IlsViewed object or a label). This method can take a variable number of arguments. See the corresponding C++ member function
IlsMvServer::OpenView. ReplyMessage(message)
This function return a message of type information to the current interactor.
ReplyWarning(message)
This function returns a warning message to the current interactor.
ReplyError(message)
This function return an error message to the current interactor.
See also the corresponding C++ member function IlsMvServer::ReplyMessage for more information on the preceding three methods.
UndeclObjectLabel(IlsViewed object)
This member function undeclares the object as an identified object. See IlsMvServer::UndeclObjectLabel.
DeclGlobalCallback(funcName, resType, nbParam)
This method declares an Rogue Wave Script function with a global callback that can be called from a component. Note that global callbacks declared using this method cannot be invoked through the MvServer object.
The resType argument takes the following valid types:
void
IlsBoolean or boolean
char
int
long
float
double
Any other type is considered as a user type. You provide only the number of arguments that your callback will receive. All arguments will be of type string.
See Also
Version 5.8
Copyright © 2014, Rogue Wave Software, Inc. All Rights Reserved.