IOGetAccessNameStatus() Function
- Last UpdatedFeb 22, 2017
- 1 minute read
The IOGetAccessNameStatus() script function returns an integer indicating the connection status of the primary, secondary, or active I/O source of an Access Name.
Typically, the IOGetAccessNameStatus() return value is associated with an integer tag. The value of the tag can drive a discrete value display animation link that shows the status of the Access Names’s active, primary, and secondary I/O sources to an operator.
Category
Miscellaneous
Syntax
Result=IOGetAccessNameStatus("AccessName", Mode);
Arguments
AccessName
The existing Access Name for which to return the status.
Mode
The value assigned to this argument determines what Access Name of the failover pair is queried about its current status.
0 - Status of the active Access Name I/O source
1 - Status of the Access Name primary I/O source
2 - Status of the Access Name secondary I/O source
Results
|
Returned Value |
Description |
|---|---|
|
-1 |
There is a configuration error in the Access Name. Either the Access Name does not exist or the Access Name does not have a defined secondary I/O source. |
|
0 |
The connection to the requested I/O source is not successful. |
|
1 |
The connection to the requested I/O source is successful. |
Remarks
The IOGetAccessNameStatus() function is typically used in a script that determines the status of the secondary IO Source that is currently inactive. The operator runs the script to verify the status of the secondary connection before forcing a fail-over.
Example
This example returns the status of the secondary I/O source of the ModbusPLC1 Access Name. The returned value is associated with the ANStatus tag.
ANStatus = IOGetAccessNameStatus ("ModbusPLC1",2)