Cicode Programming Reference > Cicode Function Categories > Display Functions Introduction > DspAnSetMetadata

DspAnSetMetadata

Non-blocking function, that sets the value of the specified metadata entry.

Note: Metadata items can only be set using Cicode if the name is configured in the object properties -metadata tab and saved with the page.

Syntax

DspAnSetMetadata(nAn, sMetaName, sValue)

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 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 called 'sMetaName', and the cicode task will stop executing

sValue:

The value for the metadata to be set.

Return Value

0 if successful, error code if unsuccessful

Related Functions

DspAnSetMetadataAt,DspAnGetMetadata, DspAnGetMetadataAt

See Also

Display Functions