AssMetadata | Super Genie Functions

Cicode Programming Reference > Cicode Function Categories > Super Genie Functions > AssMetadata

AssMetadata

This non-blocking function performs Super Genie associations using the "Name" and "Value" fields defined on the Object Properties - Metadata tab, and matches it to the 'Name' field in the page associations table. While performing associations any additional metadata entries are ignored.

Syntax

AssMetadata(hWin [, nAn])

hWin:

The associations will be created for the next Super Genie to display in the window specified. Enter the window number or

-3: for the current window when the page is changed. The page can be changed by using the Page Cicode functions like PageDisplay, PageGoto, etc.
-2: for the next new window or page displayed.

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.This parameter is optional with -2 being the default value.When -2 is specified, it is equivalent to DspGetAnCur() which returns the animation number of the current active command cursor, please refer DspGetAnCur() for usage and limitations.

UNINTENDED EQUIPMENT OPERATION

If called after other cicode functions in a command expression field, retrieve the animation number first, then pass it through the nAN parameter.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

Return Value

0 (zero) if successful, otherwise an error code is returned.When using partial associations, an error 274 may be returned even though the association is successful, and can be ignored.

Example

		/* Example of calling AssMetadata after other cicode functions */
        An = DspGetAnCur();
        SomeVal = TagRead("SomeTag");	// do additional work
        AssMetadata(-2, An);
        PageOpen("!TestSG");

Related Functions

Ass, AssChain, AssMetadataPage, AssMetadataPopup, AssMetadataWin, AssChainPage, AssChainPopUp, AssChainWin, AssChainWinFree, AssGetProperty, AssGetScale, AssInfo, AssInfoEx, AssPage, AssPopUp, AssScaleStr, AssTag, AssTitle, AssVarTags, AssWin