Win32 API 日本語リファレンス
ホーム › UI.Shell › ISyncMgrEnumItems

ISyncMgrEnumItems

COM
📘 Microsoft Learn (日本語) · English
IID6295df2a-35ee-11d1-8707-00c04fd93327継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

SYNCMGRITEM 構造体の配列を列挙するメソッドを公開します。

解説(Remarks)

実装するタイミング

登録されたアプリケーションが同期マネージャーと連携してアイテムを同期する場合、アイテムを列挙するために、このインターフェイスを備えた列挙子オブジェクトを実装する必要があります。

使用するタイミング

同期マネージャーはこのインターフェイスへのポインターを取得し、同期処理中に各メソッドを呼び出します。

メソッド 4

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

vtbl 3 HRESULT Next(DWORD celt, SYNCMGRITEM* rgelt, DWORD* pceltFetched)

列挙子のリスト内の次の celt 個の要素を列挙し、それらを rgelt に返すとともに、実際に列挙された要素の数を pceltFetched に返します。

celtDWORDin配列内のアイテムの数です。
rgeltSYNCMGRITEM*outアイテムを格納する配列のアドレスです。
pceltFetchedDWORD*out実際のアイテム数を格納する変数のアドレスです。

戻り値

型: HRESULT

メソッドが成功した場合は S_OK を返します。

解説(Remarks)

E_NOTIMPL は戻り値として許可されていません。エラー値が返された場合、終了時に rgelt 配列内のエントリはいずれも有効ではなく、解放は不要です。

vtbl 4 HRESULT Skip(DWORD celt)

列挙内の次の celt 個の要素をスキップし、次回の ISyncMgrEnumItems::Next の呼び出しでそれらの要素が返されないように列挙子に指示します。

celtDWORDinスキップするアイテムの数です。

戻り値

型: HRESULT

メソッドが成功した場合は S_OK を返します。

vtbl 5 HRESULT Reset()

要素のリストの先頭に位置付けるよう列挙子に指示します。

戻り値

型: HRESULT

メソッドが成功した場合は S_OK を返します。

解説(Remarks)

リストを走査するたびに同じ要素の集合が列挙される保証はなく、また要素が必ずしも同じ順序で列挙されるとも限りません。正確な動作は列挙対象のコレクションに依存します。ディレクトリ内のファイルなど、一部のコレクションでは特定の状態を保持するのはメモリを過度に消費するため、そのような処理は行われません。

vtbl 6 HRESULT Clone(ISyncMgrEnumItems** ppenum)

同じリストを反復処理するために、現在の列挙子と同じ状態を持つ別のアイテム列挙子を作成します。このメソッドを使用すると、列挙シーケンス内のある地点を記録し、後でその地点に戻ることができます。

ppenumISyncMgrEnumItems**outISyncMgrEnumItems インターフェイスポインターを受け取る変数のアドレスです。

戻り値

型: HRESULT

メソッドが成功した場合は S_OK を返します。

解説(Remarks)

呼び出し元のアプリケーションは、新しい列挙子を最初の列挙子とは別に解放する必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ISyncMgrEnumItems "{6295DF2A-35EE-11D1-8707-00C04FD93327}"
#usecom global ISyncMgrEnumItems IID_ISyncMgrEnumItems "{}"
#comfunc global ISyncMgrEnumItems_Next   3 int,var,var
#comfunc global ISyncMgrEnumItems_Skip   4 int
#comfunc global ISyncMgrEnumItems_Reset  5
#comfunc global ISyncMgrEnumItems_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。