Technical information

Programming - Asset Management
77
RMS Enterprise - NetLinx Programmer’s Guide
Asset Metadata Registration Functions
The Asset Metadata Registration functions in the RmsApi.axi Include File are described in the following table:
Asset Metadata Registration Functions
RmsAssetMetadata
EnqueueString
Description: This function is used to place an asset metadata property registration in queue.
This function registers a metadata property of type: STRING
Arguments:
• CHAR assetClientKey[] - asset client key
• CHAR metadataKey[] - metadata property key
• CHAR metadataName[] - metadata property name
• CHAR metadataValue[] - metadata property value
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetMetadataEnqueueString(CHAR assetClientKey[],
CHAR metadataKey[],
CHAR metadataName[],
CHAR metadataValue[])
{
STACK_VAR CHAR rmsCommand[RMS_MAX_CMD_LEN];
// ensure an asset client key has been provided
IF(assetClientKey == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetMetadataEnqueueString> :: missing asset client key';
RETURN FALSE;
}
// ensure a metadata key has been provided
IF(metadataKey == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetMetadataEnqueueString> :: missing metadata key';
RETURN FALSE;
}
// ensure a metadata name has been provided
IF(metadataName == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetMetadataEnqueueString> :: missing metadata name';
RETURN FALSE;
}
// submit the asset metadata registration now
rmsCommand = RmsPackCmdHeader('ASSET.METADATA'
);
rmsCommand = RmsPackCmdParam(rmsCommand,assetClientKey);
rmsCommand = RmsPackCmdParam(rmsCommand,metadataKey);
rmsCommand = RmsPackCmdParam(rmsCommand,metadataName);
rmsCommand = RmsPackCmdParam(rmsCommand,metadataValue);
rmsCommand = RmsPackCmdParam(rmsCommand,RMS_METADATA_TYPE_STRING);
rmsCommand = RmsPackCmdParam(rmsCommand,'true'); // read-only
SEND_COMMAND vdvRMS, rmsCommand;
RETURN TRUE;
}