Technical information

Programming - Asset Management
100
RMS Enterprise - NetLinx Programmer’s Guide
Asset Control Methods Registration Functions (Cont.)
RmsAssetControlMethod
ArgumentEnum
Description: This function is used to add an asset control method argument to an asset control method registration that is
currently in queue and has not yet been submitted to the RMS server.
The asset control method argument being added is of type: ENUMERATION. Enumeration is
provided as a pipe '|' separated list of strings.
Arguments: see method signature below
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetControlMethodArgumentEnum(CHAR assetClientKey[],
CHAR methodKey[],
INTEGER argumentOrdinal,
CHAR argumentName[],
CHAR argumentDescription[],
CHAR argumentDefaultValue[],
CHAR argumentEnumerationValues[])
{
STACK_VAR CHAR rmsCommand[RMS_MAX_CMD_LEN];
INTEGER index;
// ensure an asset client key has been provided
IF(assetClientKey == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetControlMethodArgumentEnum> :: missing asset client
key';
RETURN FALSE;
}
// ensure a control method key has been provided
IF(methodKey == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetControlMethodArgumentEnum> :: missing control method
key';
RETURN FALSE;
}
// ensure a control method argument has been provided
IF(
argumentName == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetControlMethodArgumentEnum> :: missing control method
argument name';
RETURN FALSE;
}
// submit the asset registration now
rmsCommand = RmsPackCmdHeader('ASSET.METHOD.ARGUMENT.ENUM');
rmsCommand = RmsPackCmdParam(rmsCommand,assetClientKey);
rmsCommand = RmsPackCmdParam(rmsCommand,methodKey);
rmsCommand = RmsPackCmdParam(rmsCommand,ITOA(argumentOrdinal));
rmsCommand = RmsPackCmdParam(rmsCommand,argumentName);
rmsCommand = RmsPackCmdParam(rmsCommand,argumentDescription);
rmsCommand = RmsPackCmdParam(rmsCommand,argumentDefaultValue);
rmsCommand = RmsPackCmdParam(rmsCommand,argumentEnumerationValues);
SEND_COMMAND vdvRMS, rmsCommand;
RETURN TRUE;
}