Technical information

The RMS Enterprise SDK (v4)
32
RMS Enterprise - NetLinx Programmer’s Guide
RmsApi.axi - Miscellaneous Functions
The following list of other Miscellaneous Functions can be found in the RmsApi.axi Include File:
RmsApi.axi - Miscellaneous Functions
RmsGetVersionInfo Description: This function is used to query the RMS client to display version information via the master's
telnet console.
Arguments: none
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsGetVersionInfo()
{
// send the version request to RMS
SEND_COMMAND vdvRMS, RMS_COMMAND_VERSION_REQUEST;
RETURN TRUE;
}
RmsReinitialize Description: This reinitialize request will reset the RMS connection to the server and force all the asset
parameter, control methods and metadata to be resent/registered with RMS server.
Arguments: none
Returns: n/a
Syntax:
DEFINE_FUNCTION RmsReinitialize()
{
// send the reinitialization request to RMS
SEND_COMMAND vdvRMS, RMS_COMMAND_REINITIALIZE;
}
RmsSystemPowerOn Description: This function will set the RMS system power to the ON state. System Power event
notifications will be sent out if this request causes a state change .
Arguments: none
Returns: n/a
Syntax:
DEFINE_FUNCTION RmsSystemPowerOn()
{
// set the system power to the ON state
SEND_COMMAND vdvRMS,RMS_COMMAND_SYSTEM_POWER_ON;
}
RmsSystemPowerOff Description: This function will set the RMS system power to the OFF state. System Power event
notifications will be sent out if this request causes a state change .
Arguments: none
Returns: n/a
Syntax:
DEFINE_FUNCTION RmsSystemPowerOff()
{
// set the system power to the OFF state
SEND_COMMAND vdvRMS,RMS_COMMAND_SYSTEM_POWER_OFF;
}
RmsSystemSetMode Description: This function will apply a new System Mode by name. System Mode event notifications will
be sent out if this request causes a state change
Arguments: modeName (System Mode name - see Implementing System Modes on page 114)
Returns: n/a
Syntax:
DEFINE_FUNCTION RmsSystemSetMode(CHAR modeName[])
{
STACK_VAR CHAR rmsCommand[RMS_MAX_CMD_LEN];
// set the system mode in RMS
rmsCommand = RmsPackCmdHeader(RMS_COMMAND_SYSTEM_MODE);
rmsCommand = RmsPackCmdParam(rmsCommand,modeName);
SEND_COMMAND vdvRMS, rmsCommand;
}