ホーム › System.WindowsSync › IReplicaKeyMap

IReplicaKeyMap

COM

IID2209f4fc-fd10-4ff0-84a8-f0a1982e440e継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

レプリカキーとレプリカ ID のマッピングを表します。

解説(Remarks)

レプリカ ID はレプリカのメタデータ内で繰り返し出現し、16 バイトの GUID にすることが推奨されているため、Windows Sync ではレプリカ ID を 4 バイトのレプリカキーに対応付けるマップによってレプリカ ID を表現します。そして Windows Sync は、特定のレプリカへの参照が必要な箇所でレプリカキーを使用します。

メソッド 3

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

vtbl 3 HRESULT LookupReplicaKey(BYTE* pbReplicaId, DWORD* pdwReplicaKey)

指定したレプリカ ID に対応するレプリカキーを取得します。

pbReplicaId	BYTE*	in	検索するレプリカ ID。
pdwReplicaKey	DWORD*	inout	pbReplicaId に対応するレプリカキーを返します。

戻り値

返される可能性のあるコードには、次の表に示す値が含まれます (ただしこれらに限定されません)。

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER
SYNC_E_ID_FORMAT_MISMATCH	pbReplicaId が、プロバイダーの ID 形式スキーマで指定された形式ではない場合。
SYNC_E_REPLICA_NOT_FOUND	pbReplicaId が見つからない場合。

vtbl 4 HRESULT LookupReplicaId(DWORD dwReplicaKey, BYTE* pbReplicaId, DWORD* pcbIdSize)

指定したレプリカキーに対応するレプリカ ID を取得します。

dwReplicaKey	DWORD	in	検索するレプリカキー。
pbReplicaId	BYTE*	inout	dwReplicaKey に対応するレプリカ ID を返します。
pcbIdSize	DWORD*	inout	pbReplicaId のバイト数を指定します。pbReplicaId が小さすぎる場合は ID の取得に必要なバイト数を返し、それ以外の場合は書き込まれたバイト数を返します。

戻り値

返される可能性のあるコードには、次の表に示す値が含まれます (ただしこれらに限定されません)。

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	ポインターが無効です。
SYNC_E_REPLICA_NOT_FOUND	dwReplicaKey が見つかりません。
HRESULT_FROM_WIN32(ERROR_MORE_DATA)	pbReplicaId が小さすぎます。この場合、必要なバイト数が pcbIdSize に返されます。

vtbl 5 HRESULT Serialize(BYTE* pbReplicaKeyMap, DWORD* pcbReplicaKeyMap)

レプリカキーマップのデータをバイト配列にシリアル化します。

pbReplicaKeyMap	BYTE*	inout	シリアル化されたデータを受け取るバイト配列。
pcbReplicaKeyMap	DWORD*	inout	pbReplicaKeyMap のバイト数を指定します。pbReplicaKeyMap が小さすぎる場合はレプリカキーマップのデータのシリアル化に必要なバイト数を返し、それ以外の場合は書き込まれたバイト数を返します。

戻り値

返される可能性のあるコードには、次の表に示す値が含まれます (ただしこれらに限定されません)。

戻り値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	マップに格納されているレプリカ ID またはレプリカキーが有効ではありません。
E_POINTER	ポインターが無効です。
E_OUTOFMEMORY
HRESULT_FROM_WIN32(ERROR_MORE_DATA)	pbReplicaKeyMap が小さすぎます。この場合、必要なバイト数が pcbReplicaKeyMap に返されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IReplicaKeyMap "{2209F4FC-FD10-4FF0-84A8-F0A1982E440E}"
#usecom global IReplicaKeyMap IID_IReplicaKeyMap "{}"
#comfunc global IReplicaKeyMap_LookupReplicaKey  3 var,var
#comfunc global IReplicaKeyMap_LookupReplicaId   4 int,var,var
#comfunc global IReplicaKeyMap_Serialize         5 var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IReplicaKeyMap "{2209F4FC-FD10-4FF0-84A8-F0A1982E440E}"
#usecom global IReplicaKeyMap IID_IReplicaKeyMap "{}"
#comfunc global IReplicaKeyMap_LookupReplicaKey  3 sptr,sptr
#comfunc global IReplicaKeyMap_LookupReplicaId   4 int,sptr,sptr
#comfunc global IReplicaKeyMap_Serialize         5 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。