9.4.1 開始終了UOC
機能
システム分析支援アダプタの開始終了時にUOCを実行します。
形式
ANSI C、C++の形式
#include <escom.h> ESLONG uoc_func(ESSTENINTERFACE *parm)
「uoc_func」部分には、システム内で一意の名称を指定してください。
説明
システム分析支援アダプタの開始終了時に呼び出されるUOCです。システム分析支援アダプタは、各情報を格納したパラメタの領域アドレスを引数としてUOCに渡します。
パラメタの内容
ESSTENINTERFACEのパラメタ内容
typedef struct es_sten_interface { char testid[32]; ……… テスト識別子 ESULONG call_timing; ……… 呼び出しタイミング ESULONG run_mode; ………実行形態 ESULONG abort_code; ………強制停止理由コード char reserve1[20];……… 予備領域 } ESSTENINTERFACE;
システム検証支援基盤が設定するパラメタ項目
- testid
-
システム分析支援リアルタイムモニタ定義に指定したアダプタ識別子を設定します。
- call_timing
-
プロセスの開始/終了のどのタイミングで呼び出されたか通知します。
ES_PROC_ST:プロセス開始
ES_PROC_EN:プロセス終了
- run_mode
-
実行形態を通知します。
ESCLT_RUNMODE_A:システム分析支援リアルタイムモニタ連携
ユーザが設定するパラメタ項目
- abort_code
-
システム検証支援を強制停止する理由を示すコードを0 ~ 4294967295の範囲で設定できます。
このコードはUOCがESPLG_UOC_ABORTをリターンしたときのみ有効です。システム検証支援は強制停止理由コードをKFSE64109-Eメッセージに出力します。
リターン値
次のコードでリターン値を設定してください。
- ES_UOC_OK
-
正常リターン。処理を続行します。
- ES_UOC_NG
-
異常リターン。呼び出しタイミングに応じて異常処理を行います。
-
プロセス開始時
異常終了します。
-
プロセス終了時
処理を続行します(ES_UOC_OKとして扱います)。
-
実行形態追加/実行形態削除時
実行形態の追加、または削除を中止します。
-
- ES_UOC_ABORT
-
異常リターン。KFSE64109-Eメッセージを出力し、プロセスダウンします。
- 上記以外
-
異常リターン。ES_UOC_NGと同じ動作をします。