Technical information

Programming - Asset Management
104
RMS Enterprise - NetLinx Programmer’s Guide
Asset Control Methods Registration Functions (Cont.)
RmsAssetControlMethod
Delete
Description: This function is used to delete an existing asset control method from the RMS server.
Arguments:
• CHAR assetClientKey[] - asset client key
• CHAR methodKey[] - control method key
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetControlMethodDelete(CHAR assetClientKey[],
CHAR methodKey[])
{
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 <RmsAssetControlMethodDelete> :: 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 <RmsAssetControlMethodDelete> :: missing asset client key';
RETURN FALSE;
}
// ensure a control method key has been provided
IF(methodKey == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetControlMethodDelete> :: missing control method key';
RETURN FALSE;
}
// delete existing registered asset control method
rmsCommand = RmsPackCmdHeader('ASSET.METHOD.DELETE');
rmsCommand = RmsPackCmdParam(rmsCommand,assetClientKey);
rmsCommand
= RmsPackCmdParam(rmsCommand,methodKey);
SEND_COMMAND vdvRMS, rmsCommand;
RETURN TRUE;
}