IORRGetSystemInfo() function
- Last UpdatedJun 17, 2024
- 2 minute read
The IORRGetSystemInfo() function returns a tag count for a running InTouch application. Based upon an argument value, the IORRGetSystemInfo() function returns a numerical value, which can be:
-
Maximum number of remote tag addresses specified by the InTouch license.
-
Number of remote tag addresses counted against the license over the period that an InTouch application has been running.
-
Number of remote tags currently activated in an InTouch application.
-
Number of available remote tags in a running InTouch application.
-
Number of remote reference tags, which are currently disabled.
-
Number of local tags in a running InTouch application.
-
-1 if an error occurs during the function call or the Option argument is assigned an invalid value.
Category
Miscellaneous
Syntax
IORRGetSystemInfo(Option);
Argument
Option
An integer tag or integer constant that specifies the type of remote reference tag count to return. Possible values are:
|
1 |
Returns the maximum number of permitted remote tag addresses based upon the InTouch license. Local I/O tags are not counted in the remote tag count. This number is constant while the InTouch application is running. |
|
2 |
Returns the number of unique remote tag addresses counted against the licensed limits that are activated while an InTouch application is running. Local I/O tags are not counted in the remote tag count. If the license permits more than 60K remote reference tags, this number may be 0, regardless of how many remote tag addresses are activated. While running under an unlimited license, WindowViewer does not count the activated remote tag addresses. While running an application under a license that has a remote tag limit, this count increments up to the limit of the remote tag license count. After the remote tag limit is reached, no further remote tag addresses can be activated. Only addresses currently activated can be reactivated. Use IORRWriteState with the Option argument set to 3 to obtain a list of remote reference tags that count against the license limit. |
|
3 |
Returns the number of remote reference tags currently activated within an InTouch application. |
|
4 |
Returns the number of remote reference tags that can be activated in an InTouch application without running out of remote tag handles. This count typically changes while an application is running. Stopping and starting scripts and opening and closing windows containing remote reference tags affect the remote reference tag count. This number can be less than the number still remaining on the license, especially if the license is unlimited. This occurs because there is an internal limit to how many remote reference tags can be active simultaneously. |
|
5 |
Returns the number of remote tags currently in the disabled state within an InTouch application. |
|
6 |
Returns the number of local tags currently in the InTouch application. |
Example
The following example returns the number of remote reference tags counted against the license limit while an InTouch application is running. The returned remote reference tag count is assigned as the value of the RRTagCount integer tag.
RRTagCount = IORRGetSystemInfo(2);