8.3.1.26 mqd_getevent (運用イベントを受信する)

MessageQueueDirector説明書

目次索引

8.3.1.26 mqd_getevent (運用イベントを受信する)

機能説明

　運用イベントを1件受信します。

記述形式

----------------------------------------------------------------------------------------
      #include "mqdapi.h"
      int mqd_getevent(int handle, int eventID[], int IDmax, int mode,
                       MQD_EventInfo *header, char *extend,
                       long *length, MQD_Environment *env)
----------------------------------------------------------------------------------------

パラメタ

handle

　mqd_openevent関数から返された運用イベントへのハンドルをそのまま指定します。

eventID

　受信対象にする運用イベントIDを設定してください。複数種の運用イベントを受信したい場合には受信したい運用イベントIDをすべて設定してください。すべての種類の運用イベントIDを受信したい場合には配列の先頭に“0”を設定してください。運用イベントIDの種類については“表8.26 運用イベントID一覧”を参照してください。

IDmax

　eventIDに設定した運用イベントIDの有効数を設定してください。eventIDに“0”を指定した場合には“1”を指定してください。

mode

　運用イベントがない場合の対処を指定します。

　　MQD_Q_MODE_ASYNC: 非同期モード

運用イベントがない場合には、すぐに復帰します。

　　MQD_Q_MODE_SYNC: 同期モード

運用イベントが発生するまで待ちます。

header

　運用イベント情報を入れる領域へのポインタを指定します。領域は発行元が用意します。運用イベント情報(MQD_EventInfo構造体)の詳細については、“8.3.2 パラメタの詳細説明”を参照してください。

extend

　運用イベント拡張情報を入れる領域へのポインタを指定します。領域は発行元が用意します。運用イベント拡張情報がない運用イベントだけを受信する場合にはNULLを指定します。運用イベント拡張情報の詳細については、“8.3.2 パラメタの詳細説明”を参照してください。

length

　extendで指定した領域の長さを指定します。extendにNULLを指定した場合には“0”を指定してください。

env

　例外処理のための復帰情報へのポインタを指定します。エラー詳細コードに以下の値が返されます。復帰情報(MQD_Environment構造体)の詳細については、“8.4 復帰情報の説明”を参照してください。

  MQD_ERR_SYNTAX,   MQD_ERR_NOCONNECT, MQD_ERR_NOMEMORY, MQD_ERR_BUFFERLACK,
  MQD_ERR_EVENTNOOPEN, MQD_ERR_NOEVENT, MQD_ERR_INVALIDHANDLE, MQD_ERR_GETMODE,
  MQD_ERR_IDMAX,    MQD_ERR_EXTENDLENGTH

復帰値

　本関数の処理結果が以下の復帰値で通知されます。

　正常時:　0
　異常時: -1

注意事項

　運用イベントを受信するためには、運用イベントをオープンしておく必要があります。
　eventIDに指定しなかったIDの運用イベントは通知しません。
　受信した運用イベント拡張情報が準備した領域よりも大きかった場合には、運用イベント拡張情報は通知しません。運用イベント情報のみを通知します。またこのとき、本関数の処理結果には“-1”、エラー詳細コードにはMQD_ERR_BUFFERLACKを設定します。
　運用イベントの受信はトランザクションおよび、各種メッセージ処理APIとの関連はありません。

目次索引