Cicode Programming Reference > Cicode Function Categories > Super Genie Functions Introduction > AssTag

AssTag

Associates a variable tag with the a Super Genie. The association will only be created for the next Super Genie you display in the current window, and will only come into effect after you re-display the Super Genie. You need to call this function once for every substitution string in the current Super Genie, or the super-genie variable (substitution string) will remain uninitialized and it will display as #ASS. You cannot use this function to create associations for variables that will display in new windows.

Syntax

AssTag(nArg, sTag [, ClusterName] )

nArg:

The argument number (substitution string number) of the Super Genie string to be replaced by sTag. For example, to replace ?INT 3? with sTag, set nArg to 3.

sTag:

The variable tag that will replace the Super Genie substitution string. The tag needs to be the same data type as that specified by the Super Genie substitution string. For example, only a digital tag could replace the substitution string ?DIGITAL 4?. If the substitution string does not specify a type (for example, ?5?), you can use any type except STRING.

The name of the tag can be prefixed by the name of the cluster for example, "ClusterName.Tag".

ClusterName:

Specifies the name of the cluster in which the Variable Tag resides. This is optional if you have one cluster or are resolving the tag via the current cluster context. The argument is enclosed in quotation marks "".

Resolution of the tag's cluster context occurs when the page is displayed. It is resolved to the page's cluster context, not the context in force when this function is called.

Return Value

0 (zero) if successful, otherwise an error is returned.

Related Functions

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

Example

// Associate variable tag PV123 and PV124 with !MyGenie
AssTag(1, "PV123");
AssTag(2, "PV124");
// Re-display the current Super Genie
PageDisplay("!MyGenie");

See Also

Super Genie Functions