ホーム › UI.Shell › IEnumExtraSearch

IEnumExtraSearch

COM

IID0e700be1-9db6-11d1-a1ce-00c04fd75d13継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

フォルダーで利用可能な検索オブジェクトをクライアントが判別するために使用する、標準的な OLE 列挙子です。

解説(Remarks)

名前空間拡張が 1 つ以上の検索オブジェクトをサポートする場合は、IEnumExtraSearch を実装してください。

このインターフェイスを直接呼び出すことはありません。IEnumExtraSearch インターフェイスは、IShellFolder2 インターフェイスが公開されていることをクライアントが確認した後にのみ要求されます。クライアントは IShellFolder2::EnumSearches を呼び出して、このインターフェイスへのポインターを取得します。

IEnumExtraSearch は、IUnknown および標準的な OLE 列挙メソッドを実装します。

メソッド 4

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

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

1 つ以上の検索オブジェクトに関する情報を要求するために使用します。

celt	DWORD	in	現在のオブジェクトを起点として列挙する検索オブジェクトの数です。celt が大きすぎる場合、このメソッドは処理を停止し、実際の検索オブジェクトの数を pceltFetched に返す必要があります。
rgelt	EXTRASEARCH*	out	列挙されたオブジェクトに関する情報を格納した、pceltFetched 個の EXTRASEARCH 構造体の配列へのポインターです。
pceltFetched	DWORD*	out	実際に列挙されたオブジェクトの数です。celt より少ない場合があります。

戻り値

型: HRESULT

成功した場合は S_OK を返します。それ以外の場合は COM で定義されたエラーコードを返します。

vtbl 4 HRESULT Skip(DWORD celt)

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

celt

DWORD

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

戻り値

型: HRESULT

成功した場合は S_OK を返します。それ以外の場合は COM で定義されたエラーコードを返します。

vtbl 5 HRESULT Reset()

列挙インデックスをゼロにリセットするために使用します。

戻り値

型: HRESULT

成功した場合は S_OK を返します。それ以外の場合は COM で定義されたエラーコードを返します。

vtbl 6 HRESULT Clone(IEnumExtraSearch** ppenum)

列挙子オブジェクトの現在の状態を保持するために、その複製を要求するために使用します。

ppenum

IEnumExtraSearch**

out

新しい列挙子オブジェクトの IEnumExtraSearch インターフェイスへのポインターです。

戻り値

型: HRESULT

成功した場合は S_OK を返します。それ以外の場合は COM で定義されたエラーコードを返します。

解説(Remarks)

新しい列挙子は、現在の列挙子と同じ状態で作成する必要があります。返す前に IEnumExtraSearch::Skip メソッドを使用して、列挙インデックスを適切な値まで進めてください。

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