DspGetMetadataFromNameRelative

Name used to retrieve the metadata of an object on the page relative to a given Animation Number (AN). Use the following syntax:

[RelativePath].[Group].[Group].Control

This will browse the group hierarchy from the given AN, and then drill down to other groups to find the named control or object. See Referencing an Object using a Name at Runtime for more information.

Syntax

DspGetMetadataFromNameRelative(hAN, sName, sMetaName)

hAN

AN used as the starting point for the search.

With an AN you can start the search from any level and not just the group you are in.

sName

The name of the AN used as a reference for the object.

sMetaName

The name of the metadata to be returned.

The name belonging to the metadata name/value pair defined in the object's properties metadata tab. See the topic Metadata in the main help for more information.

Return Value

The value of the metadata or blank.

Related Functions

DspSetMetadataFromNameRelative

Example

// example of relative pathing syntax
DspGetMetadataFromNameRelative(639, "..\..\Object1", "Pump")
//Using another AN as browse starting point
DspGetMetadataFromNameRelative(625, "..\..\..\Object1", "Pump")

See Also

Display Functions