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

IROTData

COM
📘 Microsoft Learn (日本語) · English
IIDf29f6bc0-5021-11ce-aa15-00006901293f継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

モニカーによって実装され、実行中オブジェクト テーブル (ROT) がモニカー同士を比較できるようにします。

メソッド 1

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

vtbl 3 HRESULT GetComparisonData(BYTE* pbData, DWORD cbMax, DWORD* pcbData)

モニカーから、別のモニカーとの等価性をテストするために使用できるデータを取得します。

pbDataBYTE*out比較データを受け取るバッファーへのポインター。
cbMaxDWORDinpbData で指定されたバッファーの長さ。
pcbDataDWORD*out比較データの長さを受け取る変数へのポインター。

戻り値

このメソッドは、標準的な戻り値である E_OUTOFMEMORY および S_OK を返すことがあります。

解説(Remarks)

GetComparisonData メソッドは、主に実行中オブジェクト テーブル (ROT) によって呼び出されます。このメソッドが返す比較データは、別のモニカーが返す比較データとバイナリの等価性がテストされます。pcbData パラメーターにより、ROT は取得したデータの末尾を特定できます。

実装者への注意

返す比較データは、可能な限り短くしつつ、モニカーを一意に識別できるものでなければなりません。比較データには、モニカーの内部状態に関する情報に加えて、モニカーの CLSID を含める必要があります。たとえば、ファイル モニカーの比較データには、モニカー内に格納されたパス名に加えて、ファイル モニカー実装の CLSID が含まれます。これにより、類似した状態情報をたまたま格納しているが、異なるモニカー クラスのインスタンスである 2 つのモニカーを区別できます。

モニカーの比較データの長さは 2048 バイトを超えることはできません。複合モニカーの場合、そのすべての構成要素の比較データの合計長は 2048 バイトを超えることはできません。したがって、モニカーが複合モニカー内の構成要素になり得る場合、返す比較データは 2048 バイトよりも大幅に小さくする必要があります。

比較データが cbMax パラメーターで指定された値よりも長い場合は、エラーを返さなければなりません。GetComparisonData が複合モニカーの構成要素に対して呼び出されると、cbMax の値はシーケンス内の各モニカーごとに小さくなっていくことに注意してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IROTData "{F29F6BC0-5021-11CE-AA15-00006901293F}"
#usecom global IROTData IID_IROTData "{}"
#comfunc global IROTData_GetComparisonData  3 var,int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。