Technical information

Programming - Asset Management
81
RMS Enterprise - NetLinx Programmer’s Guide
Asset Metadata Registration Functions (Cont.)
RmsAssetMetadata
EnqueueHyperlink
Description: This function is used to place an asset metadata property registration in queue.
This function registers a metadata property of type: HYPERLINK
Arguments:
• CHAR assetClientKey[] - asset client key
• CHAR metadataKey[] - metadata property key
• CHAR metadataName[] - metadata property name
• CHAR hyperlinkName[] - metadata hyperlink name
• CHAR hyperlinUrl[] - metadata hyperlink address
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetMetadataEnqueueHyperlink(CHAR assetClientKey[],
CHAR metadataKey[],
CHAR metadataName[],
CHAR metadataHyperlinkName[],
CHAR metadataHyperlinkUrl[])
{
STACK_VAR CHAR rmsCommand[RMS_MAX_CMD_LEN];
// ensure an asset client key has been provided
IF(assetClientKey == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetMetadataEnqueueHyperlink> :: missing asset client key';
RETURN FALSE;
}
// ensure a metadata key has been provided
IF(metadataKey == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetMetadataEnqueueHyperlink> :: missing metadata key';
RETURN FALSE;
}
// ensure a metadata name has been provided
IF(metadataName == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetMetadataEnqueueHyperlink> :: 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,''); // no value data (hyperlink)
rmsCommand = RmsPackCmdParam(rmsCommand,RMS_METADATA_TYPE_HYPERLINK);
rmsCommand = RmsPackCmdParam(rmsCommand,'true'); // read-only
rmsCommand = RmsPackCmdParam(rmsCommand,metadataHyperlinkName);
rmsCommand = RmsPackCmdParam(rmsCommand,metadataHyperlinkUrl);
SEND_COMMAND vdvRMS, rmsCommand;
RETURN TRUE;
}