Win32 API 日本語リファレンス
ホーム › System.Search › IEnumSearchRoots

IEnumSearchRoots

COM
📘 Microsoft Learn (日本語) · English
IIDab310581-ac80-11d1-8df3-00c04fb6ef52継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

カタログ (例: SystemIndex) の検索ルートを列挙するメソッドを提供します。

解説(Remarks)

Crawl Scope Manager (CSM) のインデックス作成操作に対するコマンドラインオプションを定義する方法を示すサンプルについては、CrawlScopeCommandLine コードサンプルを参照してください。

メソッド 4

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

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

指定された数の ISearchRoot 要素を取得します。

celtDWORDin取得する要素の数。
rgeltISearchRoot**outISearchRoot 要素の配列へのポインターを取得します。
pceltFetchedDWORD*inout実際に取得された要素数へのポインターを取得します。celt == 1 の場合は NULL を指定できます。それ以外の場合は NULL であってはなりません。

戻り値

型: HRESULT

成功した場合は S_OK を返します。列挙内に返すのに十分な項目が残っていない場合は S_FALSE を、それ以外の場合はエラー値を返します。

解説(Remarks)

Windows 7 以降: Crawl Scope Manager (CSM) のインデックス作成操作に対するコマンドラインオプションを定義する方法については、CrawlScopeCommandLine コードサンプルを参照してください。

vtbl 4 HRESULT Skip(DWORD celt)

指定された数の要素をスキップします。(IEnumSearchRoots.Skip)

celtDWORDinスキップする要素の数。

戻り値

型: HRESULT

成功した場合は S_OK を返します。列挙内にスキップするのに十分な項目が残っていない場合は S_FALSE を、それ以外の場合はエラー値を返します。

解説(Remarks)

Windows 7 以降: Crawl Scope Manager (CSM) のインデックス作成操作に対するコマンドラインオプションを定義する方法については、CrawlScopeCommandLine コードサンプルを参照してください。

vtbl 5 HRESULT Reset()

内部カウンターをリストの先頭に移動し、後続の IEnumSearchRoots::Next の呼び出しが先頭から取得するようにします。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

Windows 7 以降: Crawl Scope Manager (CSM) のインデックス作成操作に対するコマンドラインオプションを定義する方法については、CrawlScopeCommandLine コードサンプルを参照してください。

vtbl 6 HRESULT Clone(IEnumSearchRoots** ppenum)

現在の IEnumSearchRoots オブジェクトと同じ内容および状態を持つコピーを作成します。

ppenumIEnumSearchRoots**out新しい IEnumSearchRoots オブジェクトへのポインターを返します。呼び出し元のアプリケーションは、新しいオブジェクトの IUnknown::Release メソッドを呼び出して解放する必要があります。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

Windows 7 以降: Crawl Scope Manager (CSM) のインデックス作成操作に対するコマンドラインオプションを定義する方法については、CrawlScopeCommandLine コードサンプルを参照してください。

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