Technical information

Programming - Client Messaging
110
RMS Enterprise - NetLinx Programmer’s Guide
Sending Help Requests to RMS Server
Sending a help request to the RMS system is very simple. A convenience method exposed in the RmsApi.axi Include File wraps the
raw Send Command to the vdvRMS virtual device.
RmsSendHelpRequest ('Please send help, video projector
won't turn on');
The following table provides a detailed description of the RmsSendHelpRequest function:
Sending Maintenance Requests to RMS Server
Sending a maintenance request to the RMS system is very simple. A convenience method exposed in the RmsApi.axi Include File
wraps the raw Send Command to the vdvRMS virtual device.
RmsSendMaintenanceRequest ('Please fix the screen, it won't open');
The following table provides a detailed description of the RmsSendMaintenanceRequest function:
RmsSendHelpRequest
RmsSendHelpRequest Description: This function is used to submit a help request message to the RMS server.
Arguments:
• CHAR requestMessage[] - message body
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsSendHelpRequest(CHAR requestMessage[])
{
STACK_VAR CHAR rmsCommand[RMS_MAX_CMD_LEN];
// ensure a request message has been provided
IF(requestMessage == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsSendHelpRequest> :: missing request message';
RETURN FALSE;
}
// send the request message to RMS
rmsCommand = RmsPackCmdHeader(RMS_COMMAND_HELP_REQUEST);
rmsCommand = RmsPackCmdParam(rmsCommand,requestMessage);
SEND_COMMAND vdvRMS, rmsCommand;
RETURN TRUE;
}
RmsSendMaintenanceRequest
RmsSendMaintenance
Request
Description: This function is used to submit a maintenance request message to the RMS server.
Arguments:
• CHAR requestMessage[] - message body
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsSendMaintenanceRequest(CHAR requestMessage[])
{
STACK_VAR CHAR rmsCommand[RMS_MAX_CMD_LEN];
// ensure a request message has been provided
IF(requestMessage == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsSendMaintenanceRequest> :: missing request
message';
RETURN FALSE;
}
// send the request message to RMS
rmsCommand = RmsPackCmdHeader(RMS_COMMAND_MAINTENANCE_REQUEST);
rmsCommand = RmsPackCmdParam(rmsCommand,requestMessage);
SEND_COMMAND vdvRMS, rmsCommand;
RETURN TRUE;
}