付録A.4 MQGET命令の引数一覧
MQGET命令で指定できる引数の一覧を次の表に示します。
|
引数 |
データタイプ |
向き |
内容 |
|
|---|---|---|---|---|
|
Hconn |
MQHCONN |
i |
コネクションハンドル |
|
|
Hobj |
MQHOBJ |
i |
オブジェクトハンドル |
|
|
MsgDesc |
MQMD |
i/o |
メッセージ記述子 |
|
|
フィールド |
StrucId |
MQCHAR4 |
i |
構造体識別子 |
|
Version |
MQLONG |
i |
構造体バージョン番号 |
|
|
Report |
MQLONG |
o |
報告オプション |
|
|
MsgType |
MQLONG |
o |
メッセージタイプ |
|
|
Expiry |
MQLONG |
o |
メッセージ保持時間 |
|
|
Feedback |
MQLONG |
o |
報告メッセージ返答コード |
|
|
Encoding |
MQLONG |
o |
マシンコード形式 |
|
|
CodedCharSetId |
MQLONG |
o |
文字セット識別子 |
|
|
Format |
MQCHAR8 |
o |
フォーマット名 |
|
|
Priority |
MQLONG |
o |
メッセージ優先度 |
|
|
Persistence |
MQLONG |
o |
メッセージ永続性 |
|
|
MsgId |
MQBYTE24 |
i/o |
メッセージ識別子 |
|
|
CorrelId |
MQBYTE24 |
i/o |
相関識別子 |
|
|
BackoutCount |
MQLONG |
o |
ロールバック回数 |
|
|
ReplyToQ |
MQCHAR48 |
o |
応答キュー名 |
|
|
ReplyToQMgr |
MQCHAR48 |
o |
応答キューマネジャ名 |
|
|
UserIdentifier |
MQCHAR12 |
o |
ユーザ識別子 |
|
|
AccountingToken |
MQBYTE32 |
o |
課金トークン |
|
|
ApplIdentityData |
MQCHAR32 |
o |
アプリケーション識別データ |
|
|
PutApplType |
MQLONG |
o |
登録アプリケーションタイプ |
|
|
PutApplName |
MQCHAR28 |
o |
登録アプリケーション名 |
|
|
PutDate |
MQCHAR8 |
o |
登録日付 |
|
|
PutTime |
MQCHAR8 |
o |
登録時刻 |
|
|
ApplOriginData |
MQCHAR4 |
o |
登録元データ |
|
|
GroupId※1 |
MQBYTE24 |
i/o |
グループ識別子 |
|
|
MsgSeqNumber※1 |
MQLONG |
i/o |
メッセージシーケンス番号 |
|
|
Offset※1 |
MQLONG |
i/o |
オフセット |
|
|
MsgFlags※1 |
MQLONG |
i/o |
フラグ |
|
|
OriginalLength※1 |
MQLONG |
o |
登録元メッセージ長 |
|
|
GetMsgOpts |
MQGMO |
i/o |
メッセージ取り出しオプション |
|
|
フィールド |
StrucId |
MQCHAR4 |
i |
構造体識別子 |
|
Version |
MQLONG |
i |
構造体バージョン番号 |
|
|
Options |
MQLONG |
i |
取り出しオプション |
|
|
WaitInterval |
MQLONG |
i |
待ち合わせ最大時間 |
|
|
Signal1※2 |
MQLONG |
− |
シグナル |
|
|
Signal2 |
MQLONG |
− |
予備 |
|
|
ResolvedQName |
MQCHAR48 |
o |
受信キュー名 |
|
|
MatchOptions※1 |
MQLONG |
i |
一致オプション |
|
|
GroupStatus※1 |
MQCHAR |
o |
メッセージグループフラグ |
|
|
SegmentStatus※1 |
MQCHAR |
o |
論理メッセージフラグ |
|
|
Segmentation※1 |
MQCHAR |
o |
セグメント分割フラグ |
|
|
Reserved1※1 |
MQCHAR |
− |
予備 |
|
|
BufferLength |
MQLONG |
i |
バッファ長 |
|
|
Buffer |
MQBYTE× BufferLength |
o |
バッファ |
|
|
DataLength |
MQLONG |
o |
データ長 |
|
|
CompCode |
MQLONG |
o |
完了コード |
|
|
Reason |
MQLONG |
o |
理由コード |
|
- （凡例）
-
i：入力用
i/o：入出力用
o：出力用
−：該当しません。
- 注※1
-
Versionフィールドが，MQ*_VERSION_2の場合だけ存在するフィールドです。
- 注※2
-
TP1/Message Queueでは操作しません。
MQGET命令の引数に対応するオプションには，取り出しオプション（GetMsgOpts引数のOptionsフィールド）と報告オプション（MsgDesc引数のReportフィールド）の2種類があります。ただし，MQGET命令では，MsgDesc引数のReportフィールドは出力用のフィールドとなるため，報告オプションの指定はできません。MsgDesc引数のReportフィールドには，MQPUT命令またはMQPUT1命令でオプションを指定します。Reportフィールドで指定できる報告オプションの一覧については，「付録A.7 MQPUT命令およびMQPUT1命令の引数一覧」を参照してください。
GetMsgOpts引数のOptionsフィールドで指定できる取り出しオプションの一覧を次の表に示します。
|
オプション |
指定方法 |
オープン時に必要なオプション |
|---|---|---|
|
MQGMO_WAIT※1 |
|
MQOO_INPUT_* |
|
MQGMO_NO_WAIT （省略時解釈値） |
||
|
MQGMO_SYNCPOINT※2 |
|
|
|
MQGMO_NO_SYNCPOINT |
||
|
MQGMO_SYNCPOINT_IF_PERSISTENT※3 |
||
|
MQGMO_BROWSE_FIRST |
必要時にどれか一つだけ指定 |
|
|
MQGMO_BROWSE_NEXT |
||
|
MQGMO_BROWSE_MSG_UNDER_CURSOR |
||
|
MQGMO_MSG_UNDER_CURSOR |
MQOO_INPUT_* |
|
|
MQGMO_LOCK |
必要時に，MQGMO_BROWSE_FIRST，MQGMO_BROWSE_NEXT，またはMQGMO_BROWSE_MSG_UNDER_CURSORと同時に指定 |
|
|
MQGMO_UNLOCK※5 |
必要時に指定 |
|
|
MQGMO_ACCEPT_TRUNCATED_MSG |
||
|
MQGMO_FAIL_IF_QUIESCING※6 |
||
|
MQGMO_CONVERT |
||
|
MQGMO_COMPLETE_MSG |
||
|
MQGMO_LOGICAL_ORDER |
必要時に指定 |
|
|
MQGMO_ALL_MSGS_AVAILABLE |
||
|
MQGMO_ALL_SEGMENTS_AVAILABLE |
||
|
MQGMO_NONE |
ほかの取り出しオプションを指定しない場合に指定 |
- 注※1
-
MQGMO_BROWSE_MSG_UNDER_CURSOR，またはMQGMO_MSG_UNDER_CURSORと同時に指定すると，MQGMO_WAITは無視されます。
- 注※2
-
MQGMO_SYNCPOINTは，MQGMO_BROWSE_FIRST，MQGMO_BROWSE_NEXT，またはMQGMO_BROWSE_MSG_UNDER_CURSORと同時に指定できません。
- 注※3
-
MQGMO_SYNCPOINT_IF_PERSISTENTは，MQGMO_BROWSE_FIRST，MQGMO_BROWSE_NEXT，MQGMO_BROWSE_MSG_UNDER_CURSOR，MQGMO_COMPLETE_MSG，またはMQGMO_UNLOCKと同時に指定できません。
- 注※4
-
省略時解釈値は環境に依存します。TP1/Message Queueでは，トランザクションの範囲内から呼び出したかどうかで決まります。ほかのIBM MQの製品では，省略時解釈値が異なる場合があります。
- 注※5
-
MQGMO_NO_WAITおよびMQGMO_NO_SYNCPOINT以外の取り出しオプションと同時に指定できません。
- 注※6
-
TP1/Message Queueでは，指定しても動作に影響がありません。