ホーム › System.WindowsSync › IEnumSyncProviderInfos

IEnumSyncProviderInfos

COM

IIDa04ba850-5eb1-460d-a973-393fcb608a11継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

同期プロバイダーのインスタンスを作成するために使用する情報を格納した ISyncProviderInfo オブジェクトを列挙します。

解説(Remarks)

このインターフェイスは ISyncProviderRegistration::EnumerateSyncProviders メソッドから取得します。このメソッドは、登録されているすべての ISyncProviderInfo オブジェクト、または特定のフィルター条件に一致する登録済み ISyncProviderInfo オブジェクトのみを列挙する IEnumSyncProviderInfos 列挙子を返します。

メソッド 4

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

vtbl 3 HRESULT Next(DWORD cInstances, ISyncProviderInfo** ppSyncProviderInfo, DWORD* pcFetched)

次の ISyncProviderInfo オブジェクトを返します。

cInstances	DWORD	in	取得する ISyncProviderInfo オブジェクトの数。0 から 1 の範囲で指定します。
ppSyncProviderInfo	ISyncProviderInfo**	out	次の pcFetched 個の ISyncProviderInfo オブジェクトを返します。
pcFetched	DWORD*	out	取得された ISyncProviderInfo オブジェクトの数を返します。

戻り値

戻り値には次の表に示す値が含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。
S_FALSE	要求された数のオブジェクトが利用できませんでした。
E_POINTER	ポインターが無効です。
E_OUTOFMEMORY	次の ISyncProviderInfo オブジェクトを返すために必要なメモリが不足していました。

解説(Remarks)

このメソッドは、cInstances パラメーターで指定された数の項目を返そうとします。指定された数の項目が利用できない場合は S_FALSE が返され、pcFetched に取得できた項目の数が格納されます。

vtbl 4 HRESULT Skip(DWORD cInstances)

指定した数の ISyncProviderInfo オブジェクトをスキップします。

cInstances

DWORD

スキップする ISyncProviderInfo オブジェクトの数。

戻り値

戻り値には次の表に示す値が含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。
S_FALSE	指定された数の項目をスキップする前にコレクションの末尾に到達しました。

解説(Remarks)

スキップする項目数に達する前にコレクションの末尾に到達した場合は S_FALSE が返され、列挙子はコレクションの末尾に配置されます。以降、Skip や Next をカウント 1 で呼び出しても S_FALSE が返されます。

vtbl 5 HRESULT Reset()

列挙子を ISyncProviderInfo のセットの先頭にリセットします。

戻り値

戻り値には次の表に示す値が含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。

vtbl 6 HRESULT Clone(IEnumSyncProviderInfos** ppEnum)

列挙子を複製し、現在の列挙子と同じ状態の新しい列挙子を返します。(IEnumSyncProviderInfos.Clone)

ppEnum

IEnumSyncProviderInfos**

out

新しく複製された列挙子を返します。

戻り値

戻り値には次の表に示す値が含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	ポインターが無効です。
E_OUTOFMEMORY	列挙子を複製するために必要なメモリが不足していました。

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