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

IMessageMover

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID588a085a-b795-11d1-8054-00c04fc340ee継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

メッセージをあるキューから別のキューへ移動します。

メソッド 7

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

vtbl 7 HRESULT get_SourcePath(LPWSTR* pVal)

送信元(入力)キューの現在のパスを取得します。

pValLPWSTR*outパス。

戻り値

このメソッドは標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL、S_OK を返すことがあります。

vtbl 8 HRESULT put_SourcePath(LPWSTR newVal)

送信元(入力)キューのパスを設定します。

newValLPWSTRinパス。

戻り値

このメソッドは標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL、S_OK を返すことがあります。

vtbl 9 HRESULT get_DestPath(LPWSTR* pVal)

送信先(出力)キューのパスを取得します。

pValLPWSTR*outパス。

戻り値

このメソッドは標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL、S_OK を返すことがあります。

vtbl 10 HRESULT put_DestPath(LPWSTR newVal)

送信先(出力)キューのパスを設定します。

newValLPWSTRinパス。

戻り値

このメソッドは標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL、S_OK を返すことがあります。

vtbl 11 HRESULT get_CommitBatchSize(INT* pVal)

コミットバッチサイズを取得します。

pValINT*outコミットバッチサイズ。

戻り値

このメソッドは標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL、S_OK を返すことがあります。

vtbl 12 HRESULT put_CommitBatchSize(INT newVal)

コミットバッチサイズを設定します。これは、コミット操作の間に送信元キューから送信先キューへ移動されるメッセージ数です。

newValINTinコミットバッチサイズ。

戻り値

このメソッドは標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL、S_OK を返すことがあります。

vtbl 13 HRESULT MoveMessages(INT* plMessagesMoved)

送信元キューのすべてのメッセージを送信先キューへ移動します。

plMessagesMovedINT*out送信元から送信先キューへ移動されたメッセージ数。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

送信元キューと送信先キューの両方がトランザクション対応でない限り、メッセージは 1 件ずつ移動されます。両方がトランザクション対応の場合、CommitBatchSize が Commit の呼び出し前に移動されるメッセージ数を指定します。キュー上のすべてのメッセージより少ない件数を移動する手段はありません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

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

出力引数: 
#define global IID_IMessageMover "{588A085A-B795-11D1-8054-00C04FC340EE}"
#usecom global IMessageMover IID_IMessageMover "{ECABB0BF-7F19-11D2-978E-0000F8757E2A}"
#comfunc global IMessageMover_get_SourcePath       7 var
#comfunc global IMessageMover_put_SourcePath       8 wstr
#comfunc global IMessageMover_get_DestPath         9 var
#comfunc global IMessageMover_put_DestPath         10 wstr
#comfunc global IMessageMover_get_CommitBatchSize  11 var
#comfunc global IMessageMover_put_CommitBatchSize  12 int
#comfunc global IMessageMover_MoveMessages         13 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。