6.4.7　蓄積ファイル内容表示コマンド起動UOC

機能

蓄積ファイル内容表示コマンド開始時にUOCを実行します。

形式

ANSI C、C++の形式

#include <esafl.h>
ESLONG es_afl_data_mask_start(char **userobj, ESLONG flags);

説明

蓄積ファイル表示コマンドに指定した関数名で、コマンド開始時に一度だけ実行します。

蓄積ファイル表示コマンドの編集UOCや停止UOCに引継ぎたい情報がある場合はuserobjに確保した領域のアドレスを設定してください。そのアドレスを蓄積ファイル表示コマンド編集UOCや停止UOCに引き継ぎます。コマンドに蓄積ファイル表示コマンド起動UOC名を指定しなかった場合（デフォルト名で関数を作成した場合を除く）は実行しません。実行しなかった場合は、後続の編集UOCや停止UOCのuserobjにはNULLを渡します。

関数名（es_afl_data_mask_start）はデフォルト名であり、任意の関数名で作成可能です。その場合はコマンドのオプションに指定してください。

システムテスト支援が設定するパラメタ項目

flags

ESNOFLAGSを設定します。

ユーザが設定するパラメタ項目

userobj

蓄積ファイル表示コマンドの編集UOCや停止UOCに引継ぎたい情報領域のアドレスを設定してください。

リターン値

次のコードでリターン値を設定してください。

ES_UOC_OK

コマンドは処理続行します。

ES_UOC_NG

コマンドを中断します。

上記以外

コマンドを中断します。