JevGetEvent
機能
JevGetOpen()関数で指定した条件に合致するJP1イベントを1件取得します。この関数を繰り返し呼び出すことによって,JevGetOpen()関数で指定したフィルターに合致するJP1イベントを,イベントDBに登録された順に取得できます。
定義ヘッダー
JevApi.h
形式
JP1EVENT JevGetEvent(long* lplStatus, JEVGETKEY key, JEVACCESSTYPE access);
引数
lplStatus
この関数の異常終了時の状態コードを返す領域へのポインターを指定します。状態コードとその意味は次のとおりです。
状態コード |
意味 |
---|---|
JEV_S_CONNECT_ERROR |
イベントサービスに接続できません。 |
JEV_S_INVALID_SERVER |
イベントサーバ名が不正です。 |
JEV_S_PARAM_ERROR |
パラメーターが不正です。 |
JEV_S_NO_EVENT |
フィルターに一致するJP1イベントが存在しません。 |
JEV_S_MAXOPEN |
ファイルオープン数が限界に達しました。 |
JEV_S_NOMEMORY |
メモリー不足です。 |
JEV_S_IO_ERR |
入出力エラーです。 |
key
JP1イベント取得用ハンドル(JevGetOpen()関数の戻り値)を指定します。
access
JP1イベントを取得するときに,該当するJP1イベントが存在しない場合の動作を指定するための値を指定します。値は,次に示すどちらかです。
- JEVGET_WAIT
-
該当するJP1イベントが発生するまで制御を戻しません。
- JEVGET_NOWAIT
-
該当するJP1イベントがなければ,すぐにエラーリターンします。
戻り値
正常終了 |
JP1イベントアクセス用ハンドルを返す。 |
異常終了 |
NULLポインターを返す。また,失敗時の詳細エラーコードをlplStatusで指定された領域に格納する。 |