AMX RMS Informacje Techniczne Pobierz pdf (Strona 103)

Programming - Asset Management

RMS Enterprise - NetLinx Programmer’s Guide

Asset Metadata Update Functions

The Asset Metadata Update functions in the RmsApi.axi Include File are described in the following table:

Asset Metadata Update Functions

RmsAssetMetadata

UpdateString

Description: This function is used to update and existing asset metadata property value.

This function updates a metadata property of type: STRING

Arguments:

• CHAR assetClientKey[] - asset client key

• CHAR metadataKey[] - metadata property key

• CHAR metadataValue[] - metadata property value

Returns: 1 if call was successful; 0 if call was unsuccessful

Syntax:

DEFINE_FUNCTION CHAR RmsAssetMetadataUpdateString(CHAR assetClientKey[],

CHAR metadataKey[],

CHAR metadataValue[])

{

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 <RmsAssetMetadataUpdateString> :: RMS is not ready to accept asset

metadata changes.';

RETURN FALSE;

}

// ensure an asset client key has been provided

IF(assetClientKey == '')

{

SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetMetadataUpdateString> :: missing asset client key';

RETURN FALSE;

}

// ensure a metadata key has been provided

IF(metadataKey == '')

{

SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetMetadataUpdateString> :: missing metadata key';

RETURN FALSE;

}

// submit the asset metadata update now

RETURN RmsAssetMetadataUpdateValue(assetClientKey,metadataKey,metadataValue);

}

1 2 ... 98 99 100 101 102 103 104 105 106 107 108 ... 219 220

Brak uwag

AMX RMS Informacje Techniczne Strona 103