Technical information

Programming - Asset Management
103
RMS Enterprise - NetLinx Programmer’s Guide
Asset Control Methods Registration Functions (Cont.)
RmsAssetControlMethods
Submit
Description:
This function is used to submit any pending asset control methods that are currently in queue waiting to be registered with
RMS.
Arguments:
• CHAR assetClientKey[] - asset client key
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetControlMethodsSubmit(CHAR assetClientKey[])
{
STACK_VAR CHAR rmsCommand[RMS_MAX_CMD_LEN];
// ensure RMS is ONLINE, REGISTERED, and ready for ASSET registration
IF(![vdvRMS,RMS_CHANNEL_ASSETS_REGISTER])
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetControlMethodsSubmit> :: RMS is not ready to accept
asset control method changes.';
RETURN FALSE;
}
// ensure an asset client key has been provided
IF(assetClientKey == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetControlMethodsSubmit> :: missing asset client key';
RETURN FALSE;
}
// submit the pended queued asset registrations now
rmsCommand = RmsPackCmdHeader('ASSET.METHOD.SUBMIT');
rmsCommand = RmsPackCmdParam(rmsCommand,assetClientKey);
SEND_COMMAND vdvRMS, rmsCommand;
RETURN TRUE;
}