付録A.4 MQGET命令の引数一覧

MQGET命令で指定できる引数の一覧を次の表に示します。

表A-5 MQGET命令の引数一覧

引数データタイプ向き内容
HconnMQHCONNiコネクションハンドル
HobjMQHOBJiオブジェクトハンドル
MsgDescMQMDi/oメッセージ記述子
フィールドStrucIdMQCHAR4i構造体識別子
VersionMQLONGi構造体バージョン番号
ReportMQLONGo報告オプション
MsgTypeMQLONGoメッセージタイプ
ExpiryMQLONGoメッセージ保持時間
FeedbackMQLONGo報告メッセージ返答コード
EncodingMQLONGoマシンコード形式
CodedCharSetIdMQLONGo文字セット識別子
FormatMQCHAR8oフォーマット名
PriorityMQLONGoメッセージ優先度
PersistenceMQLONGoメッセージ永続性
MsgIdMQBYTE24i/oメッセージ識別子
CorrelIdMQBYTE24i/o相関識別子
BackoutCountMQLONGoロールバック回数
ReplyToQMQCHAR48o応答キュー名
ReplyToQMgrMQCHAR48o応答キューマネジャ名
UserIdentifierMQCHAR12oユーザ識別子
AccountingTokenMQBYTE32o課金トークン
ApplIdentityDataMQCHAR32oアプリケーション識別データ
PutApplTypeMQLONGo登録アプリケーションタイプ
PutApplNameMQCHAR28o登録アプリケーション名
PutDateMQCHAR8o登録日付
PutTimeMQCHAR8o登録時刻
ApplOriginDataMQCHAR4o登録元データ
GroupId1MQBYTE24i/oグループ識別子
MsgSeqNumber1MQLONGi/oメッセージシーケンス番号
Offset1MQLONGi/oオフセット
MsgFlags1MQLONGi/oフラグ
OriginalLength1MQLONGo登録元メッセージ長
GetMsgOptsMQGMOi/oメッセージ取り出しオプション
フィールドStrucIdMQCHAR4i構造体識別子
VersionMQLONGi構造体バージョン番号
OptionsMQLONGi取り出しオプション
WaitIntervalMQLONGi待ち合わせ最大時間
Signal12MQLONGシグナル
Signal2MQLONG予備
ResolvedQNameMQCHAR48o受信キュー名
MatchOptions1MQLONGi一致オプション
GroupStatus1MQCHARoメッセージグループフラグ
SegmentStatus1MQCHARo論理メッセージフラグ
Segmentation1MQCHARoセグメント分割フラグ
Reserved11MQCHAR予備
BufferLengthMQLONGiバッファ長
BufferMQBYTE×
BufferLength
oバッファ
DataLengthMQLONGoデータ長
CompCodeMQLONGo完了コード
ReasonMQLONGo理由コード
(凡例)
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フィールドで指定できる取り出しオプションの一覧を次の表に示します。

表A-6 取り出しオプション一覧(MQGET命令のGetMsgOpts引数のOptionsフィールド)

オプション指定方法オープン時に必要なオプション
MQGMO_WAIT1
  • どちらか一つだけ指定
  • 省略可
MQOO_INPUT_*
MQGMO_NO_WAIT
(省略時解釈値)
MQGMO_SYNCPOINT2
  • どれか一つだけ指定
  • 省略可4
MQGMO_NO_SYNCPOINT
MQGMO_SYNCPOINT_IF_PERSISTENT3
MQGMO_BROWSE_FIRST必要時にどれか一つだけ指定
  • MQOO_INPUT_*
  • MQOO_BROWSE
MQGMO_BROWSE_NEXT
MQGMO_BROWSE_MSG_UNDER_CURSOR
MQGMO_MSG_UNDER_CURSORMQOO_INPUT_*
MQGMO_LOCK必要時に,MQGMO_BROWSE_FIRST,MQGMO_BROWSE_NEXT,またはMQGMO_BROWSE_MSG_UNDER_CURSORと同時に指定
MQGMO_UNLOCK5必要時に指定
MQGMO_ACCEPT_TRUNCATED_MSG
MQGMO_FAIL_IF_QUIESCING6
MQGMO_CONVERT
MQGMO_COMPLETE_MSG
MQGMO_LOGICAL_ORDER必要時に指定
  • MQOO_INPUT_*
  • MQOO_BROWSE
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では,トランザクションの範囲内から呼び出したかどうかで決まります。ほかのWebSphere MQの製品では,省略時解釈値が異なる場合があります。
注※5
MQGMO_NO_WAITおよびMQGMO_NO_SYNCPOINT以外の取り出しオプションと同時に指定できません。
注※6
TP1/Message Queueでは,指定しても動作に影響がありません。