Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Plant SCADA

DspAnGetMetadataAt

  • Last UpdatedJul 18, 2023
  • 1 minute read

Retrieves metadata information at the specified index.

Syntax

DspAnGetMetadataAt(nAN, nIndex ,sField)

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.)

nIndex:

The index of the metadata in the animation point. The index is 0-based; i.e. the first metadata entry has an index of 0, the next 1, and so on.

sField:

The name of the field from which to retrieve the information for the metadata. Supported fields are:

• Name

• Value

Return Value

The field value string. If there is an error, an empty string is returned. The error code can be obtained by calling the IsError Cicode function.

DspAnGetMetadata,DspAnSetMetadata, DspAnSetMetadataAt

See Also

Display Functions

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in