IORRGetItemActiveState() function
- Last UpdatedJun 17, 2024
- 2 minute read
The IORRGetItemActiveState() function returns the status of a specified remote tag address.
Category
Miscellaneous
Syntax
IORRGetItemActiveState(ItemPath, Option);
Arguments
ItemPath
ItemPath is a string that represents the address of interest. ItemPath can be a string constant or a message tag.
Option
An integer tag or integer constant that specifies the type of remote reference tag count to return. Possible values are:
|
1 |
Determine if a current remote tag address is currently active. The return value is 1 if the address is current and active. The return value is -1 if the address is not current. The return value is 0 if the address is current but inactive. |
|
2 |
Determine if a current remote tag address has ever been activated while an application is running. The return value is 1 if the address is current and has been activated at least once. The return value is -1 if the address is not current. The return value is 0 if the address is current and never been activated. |
|
3 |
Determine if a current remote tag address has ever been deactivated. The return value is -1 if the address is not current. The return value is 0 if the address is current and never been deactivated. |
|
4 |
Determine if a current remote tag address is disabled. The return value is 1 if the address is current and has been deactivated at least once. The return value is -1 if the address is not current. The return value is 0 if the address is not disabled. The return value is 1 if the address is current and is disabled. |
|
5 |
Determine if the address is in the allowed list. The return value is 0 if the address is not in the list. The return value is 1 if the address is in the list. |
|
6 |
Determine if the address is in the disallowed list. The return value is 0 if the address is not in the list. The return value is 1 if the address is in the list. |
Examples
This example determines if the TestProt:di000 remote tag address is currently active:
ReturnValue = IORRGetItemActiveState("TestProt:di000", 1);
This example determines if the TestProt:di121 remote tag address is currently disabled:
ReturnValue = IORRGetItemActiveState("TestProt:di121", 4);
This example determines if the TestProt:di001 remote tag address is currently counted against the license limit.
ReturnValue = IORRGetItemActiveState("TestProt:di001", 5);