ホーム › System.WindowsSync › ICoreFragment

ICoreFragment

COM

IID613b2ab5-b304-47d9-9c31-ce6c54401a15継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

特定の変更単位のセットについて、スコープ内のすべてのアイテムに関するナレッジを表します。

解説(Remarks)

ISyncKnowledge2 オブジェクトは 1 つ以上の ICoreFragment オブジェクトを保持し、それぞれが特定の変更単位のセットに適用されるナレッジを保持します。通常、そのうちの 1 つの ICoreFragment オブジェクトは変更単位 ID を保持しません。変更単位 ID を保持しない ICoreFragment オブジェクトが持つナレッジは、他の ICoreFragment オブジェクトに含まれていないすべての変更単位 ID に適用されます。

メソッド 5

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

vtbl 3 HRESULT NextColumn(BYTE* pChangeUnitId, DWORD* pChangeUnitIdSize)

このナレッジフラグメントが適用される変更単位 ID のセットのうち、次の変更単位 ID を返します。

pChangeUnitId	BYTE*	inout	セット内の次の変更単位 ID を返します。
pChangeUnitIdSize	DWORD*	inout	pChangeUnitId のバイト数を指定します。書き込まれたバイト数を返します。pChangeUnitId が小さすぎる場合は、ID の取得に必要なバイト数を返します。

戻り値

戻り値として考えられるコードには、次の表に示す値が含まれます (ただし、これらに限定されません)。

戻り値	説明
S_OK	メソッドは成功しました。
S_FALSE	列挙する変更単位 ID はこれ以上ありません。
E_POINTER	変更単位 ID が可変長 ID であり、pChangeUnitIdSize が NULL です。
HRESULT_FROM_WIN32(ERROR_MORE_DATA)	pChangeUnitId が小さすぎます。この場合、必要なバイト数が pChangeUnitIdSize に返されます。
SYNC_E_INVALID_OPERATION	このオブジェクトに含まれるナレッジオブジェクトが、このオブジェクトの作成後に変更されました。

解説(Remarks)

ISyncKnowledge2 オブジェクトは 1 つ以上の ICoreFragment オブジェクトを保持し、それぞれが特定の列のセットに適用されるナレッジを保持します。通常、そのうちの 1 つの ICoreFragment オブジェクトは列を保持せず、そのナレッジは他のどのフラグメントにも指定されていないすべての変更単位に適用されます。この場合、NextColumn は常に S_FALSE を返します。

vtbl 4 HRESULT NextRange(BYTE* pItemId, DWORD* pItemIdSize, IClockVector** piClockVector)

このナレッジフラグメントに含まれる次の範囲と、その範囲内のアイテムについて何が既知であるかを定義するクロックベクターを返します。

pItemId	BYTE*	inout	この範囲におけるアイテム ID の下限 (この値を含む) を返します。この値は、範囲セットの先頭でない場合、直前の範囲におけるアイテム ID の上限 (この値を含まない) でもあります。
pItemIdSize	DWORD*	inout	pItemId のバイト数を指定します。書き込まれたバイト数を返します。pItemId が小さすぎる場合は、ID の取得に必要なバイト数を返します。
piClockVector	IClockVector**	out	この範囲内のアイテムについて何が既知であるかを定義するクロックベクターを返します。

戻り値

戻り値として考えられるコードには、次の表に示す値が含まれます (ただし、これらに限定されません)。

戻り値	説明
S_OK	メソッドは成功しました。
S_FALSE	列挙する範囲はこれ以上ありません。
E_POINTER	アイテム ID が可変長 ID であり、pItemIdSize が NULL です。
HRESULT_FROM_WIN32(ERROR_MORE_DATA)	pItemId が小さすぎます。この場合、必要なバイト数が pItemIdSize に返されます。
SYNC_E_INVALID_OPERATION	このオブジェクトに含まれるナレッジオブジェクトが、このオブジェクトの作成後に変更されました。

解説(Remarks)

pItemId に返される値は、piClockVector に返されるクロックベクターに関連付けられたアイテム ID の範囲の下限 (この値を含む) です。pItemId の値は直前の範囲の上限 (この値を含まない) も定義するため、現在の範囲の上限 (この値を含まない) は NextRange を再度呼び出すことで取得できます。列挙する範囲がこれ以上ない場合、その範囲には pItemId 以上の ID を持つすべてのアイテムが含まれます。

vtbl 5 HRESULT Reset()

列の列挙子と範囲の列挙子の両方を、それぞれのセットの先頭にリセットします。

戻り値

戻り値として考えられるコードには、次の表に示す値が含まれます (ただし、これらに限定されません)。

戻り値	説明
S_OK	メソッドは成功しました。
SYNC_E_INVALID_OPERATION	このオブジェクトに含まれるナレッジオブジェクトが、このオブジェクトの作成後に変更されました。

vtbl 6 HRESULT GetColumnCount(DWORD* pColumnCount)

このナレッジフラグメントに含まれる列の数を取得します。

pColumnCount

DWORD*

inout

このナレッジフラグメントに含まれる列の数を返します。

戻り値

戻り値として考えられるコードには、次の表に示す値が含まれます (ただし、これらに限定されません)。

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	ポインターが無効です。

解説(Remarks)

ISyncKnowledge2 オブジェクトは 1 つ以上の ICoreFragment オブジェクトを保持します。各オブジェクトは、特定の列のセットに適用されるナレッジを保持します。列は変更単位として表されます。通常、そのうちの 1 つの ICoreFragment オブジェクトは列を保持しません。ICoreFragment オブジェクトが列を保持しない場合、そのナレッジは他のどのフラグメントにも指定されていないすべての変更単位に適用されます。

vtbl 7 HRESULT GetRangeCount(DWORD* pRangeCount)

このナレッジフラグメントに含まれる範囲の数を取得します。

pRangeCount

DWORD*

inout

このナレッジフラグメントに含まれる範囲の数を返します。

戻り値

戻り値として考えられるコードには、次の表に示す値が含まれます (ただし、これらに限定されません)。

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	ポインターが無効です。

解説(Remarks)

ICoreFragment オブジェクトは 1 つ以上の範囲を保持します。各範囲は、アイテム ID のセットと、その範囲内のアイテムについて何が既知であるかを定義するクロックベクターを指定します。

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