MetadataName Property
The name of the metadata item.
Syntax
box.getMetadataName(index, [callback]) box.setMetadataName(index, metadataName, [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 getMetadataName([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 setMetadataName([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 the metadata item.
This property specifies the name of the metadata item. It cannot begin with the $ character.
This property may be used as input when CreateMetadata or UpdateMetadata is called.
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