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

ISearchRoot

COM
📘 Microsoft Learn (日本語) · English
IID04c18ccf-1f57-4cbd-88cc-3900f5195ce3継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

検索ルートを操作するためのメソッドを提供します。プロパティメンバーへの変更は、その検索ルート配下にあるすべての URL に適用されます。URL が検索ルートの URL に一致するか、その URL の階層的な子である場合、その URL は検索ルート配下にあるとみなされます。

解説(Remarks)

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

メソッド 22

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

vtbl 3 HRESULT put_Schedule(LPWSTR pszTaskArg)

実装されていません。(ISearchRoot.put_Schedule)

pszTaskArgLPWSTRin挿入するタスクの名前を格納した、null 終端の Unicode バッファーへのポインター。

戻り値

型: HRESULT

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

vtbl 4 HRESULT get_Schedule(LPWSTR* ppszTaskArg)

実装されていません。(ISearchRoot.get_Schedule)

ppszTaskArgLPWSTR*outタスクの名前を格納した、null 終端の Unicode バッファーへのポインターのアドレスを返します。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 5 HRESULT put_RootURL(LPWSTR pszURL)

現在の検索ルートの URL を設定します。

pszURLLPWSTRinこの検索ルートの URL を格納した、null 終端の Unicode バッファーへのポインター。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 6 HRESULT get_RootURL(LPWSTR* ppszURL)

この検索ルートの起点となる URL を取得します。

ppszURLLPWSTR*outURL を格納した、null 終端の Unicode バッファー。

戻り値

型: HRESULT

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

解説(Remarks)

返された文字列のメモリを解放するには、CoTaskMemFree を使用してください。

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

vtbl 7 HRESULT put_IsHierarchical(BOOL fIsHierarchical)

検索が階層的なツリー構造を対象としているかどうかを示す値を設定します。

fIsHierarchicalBOOLin階層的なツリー構造の場合は TRUE、Web サイトなどの非階層的なシステムの場合は FALSE。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 8 HRESULT get_IsHierarchical(BOOL* pfIsHierarchical)

検索が階層的なツリー構造を対象としているかどうかを示す値を取得します。

pfIsHierarchicalBOOL*out戻り時に、階層的なツリー構造の場合は TRUE、Web サイトなどのその他の構造の場合は FALSE を指します。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 9 HRESULT put_ProvidesNotifications(BOOL fProvidesNotifications)

検索ルート配下の URL に対する変更が、(プロトコルハンドラーやその他のアプリケーションによって) 検索エンジンに通知されるかどうかを示す値を設定します。

fProvidesNotificationsBOOLin通知が提供される場合は TRUE、それ以外の場合は FALSE。

戻り値

型: HRESULT

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

解説(Remarks)

ISearchRoot::put_ProvidesNotifications が設定する値は、プロトコル固有のものではありません。

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

vtbl 10 HRESULT get_ProvidesNotifications(BOOL* pfProvidesNotifications)

検索ルート配下の URL に対する変更が、(プロトコルハンドラーやその他のアプリケーションによって) 検索エンジンに通知されるかどうかを示す値を取得します。

pfProvidesNotificationsBOOL*out戻り時に、この検索ルートが通知を提供する場合は TRUE、それ以外の場合は FALSE を指します。

戻り値

型: HRESULT

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

解説(Remarks)

ISearchRoot::get_ProvidesNotifications が返す値は、プロトコル固有のものではありません。

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

vtbl 11 HRESULT put_UseNotificationsOnly(BOOL fUseNotificationsOnly)

この検索ルートを、クロールせずに通知のみによってインデックス化するかどうかを示す値を設定します。

fUseNotificationsOnlyBOOLinこの検索ルートを通知のみによってインデックス化する場合は TRUE、それ以外の場合は FALSE。

戻り値

型: HRESULT

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

解説(Remarks)

カスタムデータストアやリモートシステム上にある検索ルート URL では、そのストアやシステムが変更発生の通知を送信した場合にのみ検索エンジンが URL をインデックス化するように制限すると有用な場合があります。これにより、ストアに変更がないときの増分クロールを回避し、ストア内やネットワーク上のトラフィックを削減できる可能性があります。

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

vtbl 12 HRESULT get_UseNotificationsOnly(BOOL* pfUseNotificationsOnly)

この検索ルートを、クロールせずに通知のみによってインデックス化するかどうかを示す値を取得します。

pfUseNotificationsOnlyBOOL*out戻り時に、この検索ルートを通知のみによってインデックス化する場合は TRUE、それ以外の場合は FALSE を指します。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 13 HRESULT put_EnumerationDepth(DWORD dwDepth)

この検索ルートの列挙の深さを設定します。

dwDepthDWORDin列挙する深さ (階層数)。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 14 HRESULT get_EnumerationDepth(DWORD* pdwDepth)

この検索ルートの列挙の深さを取得します。

pdwDepthDWORD*out列挙する深さ (階層数) へのポインター。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 15 HRESULT put_HostDepth(DWORD dwDepth)

インデックス作成時にホストツリーをどの深さまでクロールするかを示す値を設定します。

dwDepthDWORDinホストツリーをクロールする深さ (階層数)。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 16 HRESULT get_HostDepth(DWORD* pdwDepth)

インデックス作成時にホストツリーをどの深さまでクロールするかを示す値を取得します。

pdwDepthDWORD*out戻り時に、ホストツリーをクロールする深さ (階層数) を指します。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 17 HRESULT put_FollowDirectories(BOOL fFollowDirectories)

この検索ルートについて、検索エンジンがサブディレクトリや階層的なスコープをたどるかどうかを示す BOOL 値を設定します。

fFollowDirectoriesBOOLinディレクトリや階層的なスコープをたどる場合は TRUE、それ以外の場合は FALSE。この値の既定値は TRUE です。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 18 HRESULT get_FollowDirectories(BOOL* pfFollowDirectories)

検索エンジンがサブディレクトリや階層的なスコープをたどるかどうかを示す BOOL 値を取得します。

pfFollowDirectoriesBOOL*out戻り時に、検索エンジンがサブディレクトリや階層的なスコープをたどる場合は TRUE、それ以外の場合は FALSE を指します。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 19 HRESULT put_AuthenticationType(AUTH_TYPE authType)

この検索ルート配下の URL にアクセスするために必要な認証の種類を設定します。

authTypeAUTH_TYPEin認証の種類を示す AUTH_TYPE 列挙型の値。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 20 HRESULT get_AuthenticationType(AUTH_TYPE* pAuthType)

この検索ルート配下の URL にアクセスするために必要な認証の種類を取得します。

pAuthTypeAUTH_TYPE*outこの検索ルート配下の URL にアクセスするために必要な認証の種類を示す、AUTH_TYPE 列挙型の値へのポインター。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 21 HRESULT put_User(LPWSTR pszUser)

実装されていません。(ISearchRoot.put_User)

pszUserLPWSTRinこのパラメーターは使用されません。

戻り値

型: HRESULT

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

vtbl 22 HRESULT get_User(LPWSTR* ppszUser)

実装されていません。(ISearchRoot.get_User)

ppszUserLPWSTR*outこのパラメーターは使用されません。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 23 HRESULT put_Password(LPWSTR pszPassword)

実装されていません。(ISearchRoot.put_Password)

pszPasswordLPWSTRinこのパラメーターは使用されません。

戻り値

型: HRESULT

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

vtbl 24 HRESULT get_Password(LPWSTR* ppszPassword)

実装されていません。(ISearchRoot.get_Password)

ppszPasswordLPWSTR*outこのパラメーターは使用されません。

戻り値

型: 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_ISearchRoot "{04C18CCF-1F57-4CBD-88CC-3900F5195CE3}"
#usecom global ISearchRoot IID_ISearchRoot "{}"
#comfunc global ISearchRoot_put_Schedule               3 wstr
#comfunc global ISearchRoot_get_Schedule               4 var
#comfunc global ISearchRoot_put_RootURL                5 wstr
#comfunc global ISearchRoot_get_RootURL                6 var
#comfunc global ISearchRoot_put_IsHierarchical         7 int
#comfunc global ISearchRoot_get_IsHierarchical         8 var
#comfunc global ISearchRoot_put_ProvidesNotifications  9 int
#comfunc global ISearchRoot_get_ProvidesNotifications  10 var
#comfunc global ISearchRoot_put_UseNotificationsOnly   11 int
#comfunc global ISearchRoot_get_UseNotificationsOnly   12 var
#comfunc global ISearchRoot_put_EnumerationDepth       13 int
#comfunc global ISearchRoot_get_EnumerationDepth       14 var
#comfunc global ISearchRoot_put_HostDepth              15 int
#comfunc global ISearchRoot_get_HostDepth              16 var
#comfunc global ISearchRoot_put_FollowDirectories      17 int
#comfunc global ISearchRoot_get_FollowDirectories      18 var
#comfunc global ISearchRoot_put_AuthenticationType     19 int
#comfunc global ISearchRoot_get_AuthenticationType     20 var
#comfunc global ISearchRoot_put_User                   21 wstr
#comfunc global ISearchRoot_get_User                   22 var
#comfunc global ISearchRoot_put_Password               23 wstr
#comfunc global ISearchRoot_get_Password               24 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。