10.4 hamon_patrolstop(UAPの監視終了)
形式
#include <HA_mon_uap.h> long hamon_patrolstop(int *inf, void *opt);
機能
UAPの監視終了をHAモニタに要求します。UAPを監視したままUAPを終了すると,HAモニタがUAP障害を検出してしまうため,UAPを終了する前に必ずこの関数を発行してください。
UAPの起動時には,あらかじめHAMON_UAPNAME環境変数に,モニタモードのプログラム対応の環境設定のnameオペランドに指定したプログラム名を設定しておく必要があります。
なお,HAMON_API_PATROL環境変数にnouseを指定した場合は,HAモニタへの要求は行わないでリターンコード0でリターンします。
UAPの環境変数については,「6.17.2 UAPの環境変数の設定」を参照してください。
UAPで値を設定する引数
-
opt
予備領域です。NULLを指定します。
HAモニタから値が返される引数
-
inf
エラー時の詳細コードを返却するための領域です。詳細コードについては,「10.5 詳細コードの一覧」を参照してください。
リターンコード
値 |
意味 |
---|---|
0 |
HAモニタは,この関数を発行したUAPの監視を終了します。 |
-1 |
エラーが発生しました。詳細については,「10.5 詳細コードの一覧」を参照してください。 |
注意事項
-
この関数は,hamon_patrolstart関数を発行したプロセス(スレッド)から発行してください。
-
この関数は,同一プロセスから連続して複数回発行しないでください。
-
1プロセスでAPIを発行できるのは1スレッドだけです。