Technical information

Programming - Asset Management
93
RMS Enterprise - NetLinx Programmer’s Guide
Asset Control Methods Registration Functions
The Asset Control Methods Registration functions in the RmsApi.axi Include File are described in the following table:
Asset Control Methods Registration Functions
RmsAssetControlMethod
Enqueue
Description: This function is used to place an asset control method registration in queue in the RMS client.
Arguments:
• CHAR assetClientKey[] - asset client key
• CHAR methodKey[] - control method key
• CHAR methodName[] - control method name
• CHAR methodDescription[] - control method description
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetControlMethodEnqueue(CHAR assetClientKey[],
CHAR methodKey[],
CHAR methodName[],
CHAR methodDescription[])
{
STACK_VAR CHAR rmsCommand[RMS_MAX_CMD_LEN];
// ensure an asset client key has been provided
IF(assetClientKey == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetControlMethodEnqueue> :: missing asset client key';
RETURN FALSE;
}
// ensure a control method key has been provided
IF(methodKey == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetControlMethodEnqueue> :: missing control method key';
RETURN FALSE;
}
// ensure a control method key has been provided
IF(methodName == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetControlMethodEnqueue> :: missing control method name';
RETURN FALSE;
}
// enqueue asset control method for registration
rmsCommand = RmsPackCmdHeader('ASSET.METHOD'
);
rmsCommand = RmsPackCmdParam(rmsCommand,assetClientKey);
rmsCommand = RmsPackCmdParam(rmsCommand,methodKey);
rmsCommand = RmsPackCmdParam(rmsCommand,methodName);
rmsCommand = RmsPackCmdParam(rmsCommand,methodDescription);
SEND_COMMAND vdvRMS, rmsCommand;
RETURN TRUE;
}