DspAnGetMetadata
Retrieves the field value of the specified metadata entry.
Syntax
DspAnGetMetadata(nAn, sMetaName)
nAn:
An animation number that uniquely identifies an object. This object contains the list of metadata definitions that will be used to perform the association operations. When -2 is specified, it is equivalent to using DspGetAnCur(). (See DspGetAnCur for usage and limitations.)
sMetaName:
The name of the metadata entry for which to search.
Note: Before calling this function, it may be worthwhile to call ErrSet(1) to disable error checking as this function will generate a hardware error for any object that does not have a metadata entry 'sMetaName', and the cicode task will stop executing.
Return Value
Value for the specified metadata. Returns empty string if a matching metadata entry is not defined and error code CT_ERROR_OBJECT_NOT_FOUND is set.
Related Functions
DspAnGetMetadataAt,DspAnSetMetadata, DspAnSetMetadataAt
See Also