MetadataSourceName Property

The name of another metadata item from which to copy or move a value.

Syntax

 box.getMetadataSourceName(index, [callback])
 box.setMetadataSourceName(index,  metadataSourceName, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getMetadataSourceName([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setMetadataSourceName([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The name of another metadata item from which to copy or move a value.

This property specifies the name of another metadata item whose value should be copied or moved to this one. It cannot begin with the $ character.

This property may be used as input when UpdateMetadata is called if the MetadataModOp property is set to one of the following:

• 3 (opCopyFrom)
• 4 (opMoveFrom)

The index parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.

This property is not available at design time.

Data Type

String