ISearchRoot::get_HostDepth method (searchapi.h)

[get_HostDepth may be altered or unavailable in subsequent versions of the operating system or product.]

Gets a value that indicates how far into a host tree to crawl when indexing.

Syntax

HRESULT get_HostDepth(
  [out] DWORD *pdwDepth
);

Parameters

[out] pdwDepth

Type: DWORD*

On return, points to the depth (number of levels) to crawl in the host tree.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Windows 7 and later: Check out the CrawlScopeCommandLine code sample to see how to define command line options for Crawl Scope Manager (CSM) indexing operations.

Requirements