IOGetAccessNameStatus() 関数
- Last UpdatedMar 13, 2018
- 1 minute read
IOGetAccessNameStatus() スクリプト関数は、アクセス名のメイン、セカンダリ、またはアクティブな I/O ソースの接続ステータスを示す整数値を返します。
IOGetAccessNameStatus() の戻り値は、通常は整数型タグ変数に関連付けられます。このタグ変数の値により、アクティブ、メイン、およびセカンダリの、アクセス名の I/O ソースのステータスをユーザーに示す論理値表示アニメーション リンクを動作させることができます。
カテゴリ
その他
構文
Result=IOGetAccessNameStatus("AccessName", Mode);
引数
AccessName
ステータスを返す既存のアクセス名。
Mode
この引数に割り当てる値に応じて、どのフェイルオーバー ペアのアクセス名に対して現在のステータスに関するクエリーを実行するかが決まります。
0 - アクティブなアクセス名 I/O ソースのステータス
1 - アクセス名のメイン I/O ソースのステータス
2 - アクセス名のセカンダリ I/O ソースのステータス
結果
|
返り値 |
説明 |
|---|---|
|
-1 |
アクセス名に設定エラーがあります。アクセス名が存在しないか、またはアクセス名にセカンダリ I/O ソースが定義されていません。 |
|
0 |
要求した I/O ソースとの接続に失敗しました。 |
|
1 |
要求した I/O ソースとの接続に成功しました。 |
備考
IOGetAccessNameStatus() 関数は通常、現在非アクティブなセカンダリ I/O ソースのステータスを確認するスクリプトに使用されます。ユーザーはこのスクリプトを実行して、フェイルオーバーの強制を実行する前にセカンダリ接続のステータスを確認します。
例
以下の例は、アクセス名 ModbusPLC1 のセカンダリ I/O ソースのステータスを返します。返り値は ANStatus タグ変数に関連付けられます。
ANStatus = IOGetAccessNameStatus ("ModbusPLC1",2)