ホーム › System.Com › IRpcChannelBuffer

IRpcChannelBuffer

COM

📘 Microsoft Learn (日本語) · English

IIDd5f56b60-593b-101a-b569-08002b2dbf7a継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IRpcChannelBuffer (objidlbase.h) インターフェイスは、COM クライアントのプロキシと COM サーバーのスタブの間でデータをマーシャリングします。

メソッド 5

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetBuffer(RPCOLEMESSAGE* pMessage, GUID* riid)

IRpcChannelBuffer::GetBuffer (objidlbase.h) メソッドは、送信用にデータをマーシャリングできるバッファーを取得します。

pMessage	RPCOLEMESSAGE*	inout	RPCOLEMESSAGE データ構造体へのポインター。
riid	GUID*	in	マーシャリングするインターフェイスの識別子への参照。

戻り値

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

vtbl 4 HRESULT SendReceive(RPCOLEMESSAGE* pMessage, DWORD* pStatus)

IRpcChannelBuffer::SendReceive (objidlbase.h) メソッドは、RPC チャネルを経由してメソッドの呼び出しをサーバーのスタブへ送信します。

pMessage	RPCOLEMESSAGE*	inout	マーシャリングされたデータが格納された RPCOLEMESSAGE 構造体へのポインター。
pStatus	DWORD*	outoptional	NULL でない場合、実行が成功すると 0 に設定されます。

戻り値

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

解説(Remarks)

このメソッドを呼び出す前に、チャネルバッファーを割り当てるために GetBuffer メソッドを呼び出しておく必要があります。呼び出しから戻ると、RPCOLEMESSAGE 構造体の dataRepresentation バッファーは、サーバー上で呼び出されたメソッドが返したデータを含むように変更されています。呼び出しが成功した場合、RPC チャネルバッファーは解放されています。それ以外の場合、呼び出し元は FreeBuffer を呼び出して明示的に解放する必要があります。

vtbl 5 HRESULT FreeBuffer(RPCOLEMESSAGE* pMessage)

IRpcChannelBuffer::FreeBuffer (objidlbase.h) メソッドは、以前に割り当てられた RPC チャネルバッファーを解放します。

pMessage

RPCOLEMESSAGE*

inout

RPCOLEMESSAGE データ構造体へのポインター。

戻り値

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

vtbl 6 HRESULT GetDestCtx(DWORD* pdwDestContext, void** ppvDestContext)

IRpcChannelBuffer::GetDestCtx (objidlbase.h) メソッドは、RPC チャネルの宛先コンテキストを取得します。

pdwDestContext	DWORD*	out	インターフェイスがアンマーシャリングされる宛先コンテキスト。指定可能な値は MSHCTX 列挙体に含まれます。
ppvDestContext	void**	out	このパラメーターは予約されており、NULL でなければなりません。

戻り値

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

vtbl 7 HRESULT IsConnected()

IRpcChannelBuffer::IsConnected (objidlbase.h) メソッドは、RPC チャネルが接続されているかどうかを判定します。

戻り値

RPC チャネルが存在する場合、戻り値は TRUE です。それ以外の場合は FALSE です。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IRpcChannelBuffer "{D5F56B60-593B-101A-B569-08002B2DBF7A}"
#usecom global IRpcChannelBuffer IID_IRpcChannelBuffer "{}"
#comfunc global IRpcChannelBuffer_GetBuffer    3 var,var
#comfunc global IRpcChannelBuffer_SendReceive  4 var,var
#comfunc global IRpcChannelBuffer_FreeBuffer   5 var
#comfunc global IRpcChannelBuffer_GetDestCtx   6 var,sptr
#comfunc global IRpcChannelBuffer_IsConnected  7
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IRpcChannelBuffer "{D5F56B60-593B-101A-B569-08002B2DBF7A}"
#usecom global IRpcChannelBuffer IID_IRpcChannelBuffer "{}"
#comfunc global IRpcChannelBuffer_GetBuffer    3 sptr,sptr
#comfunc global IRpcChannelBuffer_SendReceive  4 sptr,sptr
#comfunc global IRpcChannelBuffer_FreeBuffer   5 sptr
#comfunc global IRpcChannelBuffer_GetDestCtx   6 sptr,sptr
#comfunc global IRpcChannelBuffer_IsConnected  7
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。