Win32 API 日本語リファレンス
ホーム › System.MessageQueuing › IMSMQQueue

IMSMQQueue

COMIDispatch (デュアル)
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IIDd7d6e076-dccd-11d0-aa4b-0060970debae継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

メソッド 13

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get_Access(INT* plAccess)
plAccessINT*outキューを開いた際のアクセスモードを受け取るポインタである。
vtbl 8 HRESULT get_ShareMode(INT* plShareMode)
plShareModeINT*outキューを開いた際の共有モードを受け取るポインタである。
vtbl 9 HRESULT get_QueueInfo(IMSMQQueueInfo** ppqinfo)
ppqinfoIMSMQQueueInfo**outこのキューに対応するキュー情報オブジェクト(IMSMQQueueInfo)を受け取るポインタである。
vtbl 10 HRESULT get_Handle(INT* plHandle)
plHandleINT*outキューの内部ハンドルを受け取るポインタである。
vtbl 11 HRESULT get_IsOpen(SHORT* pisOpen)
pisOpenSHORT*outキューが現在開かれているかどうかを受け取るポインタである。
vtbl 12 HRESULT Close()
vtbl 13 HRESULT Receive(VARIANT* Transaction, VARIANT* WantDestinationQueue, VARIANT* WantBody, VARIANT* ReceiveTimeout, IMSMQMessage** ppmsg)
TransactionVARIANT*in受信または送信を行うトランザクションを格納した VARIANT へのポインタである。トランザクション種別の定数を渡すことも、トランザクションオブジェクトを渡すこともできる。省略可。
WantDestinationQueueVARIANT*in受信するメッセージの宛先キュー情報を取得するかどうかを格納した VARIANT へのポインタである。省略時は取得しない。
WantBodyVARIANT*in受信するメッセージの本文を取得するかどうかを格納した VARIANT へのポインタである。省略時は取得する。
ReceiveTimeoutVARIANT*inメッセージが到着するまで待機する最大時間(ミリ秒)を格納した VARIANT へのポインタである。省略時は無限に待機する。
ppmsgIMSMQMessage**out受信または参照したメッセージオブジェクト(IMSMQMessage)を受け取るポインタである。要求に該当するメッセージが無い場合は NULL が返る。
vtbl 14 HRESULT Peek(VARIANT* WantDestinationQueue, VARIANT* WantBody, VARIANT* ReceiveTimeout, IMSMQMessage** ppmsg)
WantDestinationQueueVARIANT*in受信するメッセージの宛先キュー情報を取得するかどうかを格納した VARIANT へのポインタである。省略時は取得しない。
WantBodyVARIANT*in受信するメッセージの本文を取得するかどうかを格納した VARIANT へのポインタである。省略時は取得する。
ReceiveTimeoutVARIANT*inメッセージが到着するまで待機する最大時間(ミリ秒)を格納した VARIANT へのポインタである。省略時は無限に待機する。
ppmsgIMSMQMessage**out受信または参照したメッセージオブジェクト(IMSMQMessage)を受け取るポインタである。要求に該当するメッセージが無い場合は NULL が返る。
vtbl 15 HRESULT EnableNotification(IMSMQEvent* Event, VARIANT* Cursor, VARIANT* ReceiveTimeout)
EventIMSMQEvent*inoptionalメッセージ到着を非同期に通知する MSMQ イベントオブジェクトへのポインタである。
CursorVARIANT*in走査位置を制御するカーソル種別を格納した VARIANT へのポインタである。省略可。
ReceiveTimeoutVARIANT*inメッセージが到着するまで待機する最大時間(ミリ秒)を格納した VARIANT へのポインタである。省略時は無限に待機する。
vtbl 16 HRESULT Reset()
vtbl 17 HRESULT ReceiveCurrent(VARIANT* Transaction, VARIANT* WantDestinationQueue, VARIANT* WantBody, VARIANT* ReceiveTimeout, IMSMQMessage** ppmsg)
TransactionVARIANT*in受信または送信を行うトランザクションを格納した VARIANT へのポインタである。トランザクション種別の定数を渡すことも、トランザクションオブジェクトを渡すこともできる。省略可。
WantDestinationQueueVARIANT*in受信するメッセージの宛先キュー情報を取得するかどうかを格納した VARIANT へのポインタである。省略時は取得しない。
WantBodyVARIANT*in受信するメッセージの本文を取得するかどうかを格納した VARIANT へのポインタである。省略時は取得する。
ReceiveTimeoutVARIANT*inメッセージが到着するまで待機する最大時間(ミリ秒)を格納した VARIANT へのポインタである。省略時は無限に待機する。
ppmsgIMSMQMessage**out受信または参照したメッセージオブジェクト(IMSMQMessage)を受け取るポインタである。要求に該当するメッセージが無い場合は NULL が返る。
vtbl 18 HRESULT PeekNext(VARIANT* WantDestinationQueue, VARIANT* WantBody, VARIANT* ReceiveTimeout, IMSMQMessage** ppmsg)
WantDestinationQueueVARIANT*in受信するメッセージの宛先キュー情報を取得するかどうかを格納した VARIANT へのポインタである。省略時は取得しない。
WantBodyVARIANT*in受信するメッセージの本文を取得するかどうかを格納した VARIANT へのポインタである。省略時は取得する。
ReceiveTimeoutVARIANT*inメッセージが到着するまで待機する最大時間(ミリ秒)を格納した VARIANT へのポインタである。省略時は無限に待機する。
ppmsgIMSMQMessage**out受信または参照したメッセージオブジェクト(IMSMQMessage)を受け取るポインタである。要求に該当するメッセージが無い場合は NULL が返る。
vtbl 19 HRESULT PeekCurrent(VARIANT* WantDestinationQueue, VARIANT* WantBody, VARIANT* ReceiveTimeout, IMSMQMessage** ppmsg)
WantDestinationQueueVARIANT*in受信するメッセージの宛先キュー情報を取得するかどうかを格納した VARIANT へのポインタである。省略時は取得しない。
WantBodyVARIANT*in受信するメッセージの本文を取得するかどうかを格納した VARIANT へのポインタである。省略時は取得する。
ReceiveTimeoutVARIANT*inメッセージが到着するまで待機する最大時間(ミリ秒)を格納した VARIANT へのポインタである。省略時は無限に待機する。
ppmsgIMSMQMessage**out受信または参照したメッセージオブジェクト(IMSMQMessage)を受け取るポインタである。要求に該当するメッセージが無い場合は NULL が返る。

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IMSMQQueue "{D7D6E076-DCCD-11D0-AA4B-0060970DEBAE}"
#usecom global IMSMQQueue IID_IMSMQQueue "{D7D6E079-DCCD-11D0-AA4B-0060970DEBAE}"
#comfunc global IMSMQQueue_get_Access          7 var
#comfunc global IMSMQQueue_get_ShareMode       8 var
#comfunc global IMSMQQueue_get_QueueInfo       9 sptr
#comfunc global IMSMQQueue_get_Handle          10 var
#comfunc global IMSMQQueue_get_IsOpen          11 var
#comfunc global IMSMQQueue_Close               12
#comfunc global IMSMQQueue_Receive             13 var,var,var,var,sptr
#comfunc global IMSMQQueue_Peek                14 var,var,var,sptr
#comfunc global IMSMQQueue_EnableNotification  15 sptr,var,var
#comfunc global IMSMQQueue_Reset               16
#comfunc global IMSMQQueue_ReceiveCurrent      17 var,var,var,var,sptr
#comfunc global IMSMQQueue_PeekNext            18 var,var,var,sptr
#comfunc global IMSMQQueue_PeekCurrent         19 var,var,var,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。