ISearchRoot::put_HostDepth method (searchapi.h)

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

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

Syntax

HRESULT put_HostDepth(
  [in] DWORD dwDepth
);

Parameters

[in] dwDepth

Type: DWORD

The depth (number of levels) to crawl a 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

Requirement Value
Minimum supported client Windows XP with SP2, Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header searchapi.h