AssInfoEx
Gets association information about the current Super Genie (that is information about a variable tag that has been substituted into the Super Genie). You can only call this function on a Super Genie after the associations are completed.
Use this function to display association information as part of the Super Genie. For example, if you have a Super Genie that is a loop controller, you could display the name of the loop at the top of the loop controller box. Each time the Super Genie is used with different associations (specifically a different tag name association) the correct loop name will be displayed.
Note: When replacing an instance of AssInfo with AssInfoEx in a loop, you may want to make AssInfoEx blocking using the iCached argument to verify you are using the correct value for the Tag in your logic.
Syntax
AssInfoEx(nArg, nType [, iCached] )
nArg:
When you associate variable tags with super Genies, the Super Genie substitution strings are replaced by variable tags. The nArg argument allows you to get information about one of those variable tags. What you need to know is which substitution string it replaced when the association was performed.
Enter the argument number (substitution string number) of the relevant substitution string. For example, if you want information about the variable that replaced substitution string
?INT 3?
set nArg to 3.
nType:
The type of information to get:
0 - The Tag name of the association. If the association tag is not resolved, returns an empty string.
1 - Engineering units
2 - Raw zero scale
3 - Raw full scale
4 - Engineering zero scale
5 - Engineering full scale
6 - Width of the format
7 - Number of decimal places of format
8-16 - Not supported
17 - ClusterName of the tag. If the association tag is not resolved, returns an empty string.
18 - Full name (cluster.tagname) of the associated tag. If the association tag is not resolved, returns an empty string.
19 - Full name (cluster.tagname) of the associated tag even if the association tag is not resolved.
iCached:
Optional flag to attempt to retrieve the cached value for the property rather than the current value. This makes the function non-blocking. If the property has not yet been cached, an error is set.
0 - Do not force cached read. Cicode is blocking
1 - Force cached read. Cicode is non-blocking
Default value is 1 (true).
Return Value
The value of the information as a string. If an error is detected an empty string is returned. The error code can be obtained by calling the IsError Cicode function.
Related Functions
Ass, AssChain, AssMetadata, AssMetadataPage, AssMetadataPopup, AssMetadataWin, AssChainPage, AssChainPopUp, AssChainWin, AssChainWinFree, AssGetProperty, AssGetScale, AssInfo, AssPage, AssPopUp, AssScaleStr, AssTag, AssTitle, AssVarTags, AssWin, TagGetProperty, TagGetScale, TagScaleStr, TagInfo, TagInfoEx
Example
//Using a string identifier for the substitution parameter
AssInfoEx("MILK_LEVEL", 1, 0); (to get Engineering units, no cache read)
sTag = AssInfoEx(1, 0); // Get the name of association 1 in non-blocking mode
sEngLow = AssInfoEx(1, 4, 0); // get the low engineering scale of association 1, block until data is available
See Also