ISearchCrawlScopeManager::EnumerateRoots method (searchapi.h)

Returns an enumeration of all the roots of which this instance of the ISearchCrawlScopeManager is aware.

Syntax

HRESULT EnumerateRoots(
  [out, retval] IEnumSearchRoots **ppSearchRoots
);

Parameters

[out, retval] ppSearchRoots

Type: IEnumSearchRoots**

Returns a pointer to an IEnumSearchRoots interface.

Return value

Type: HRESULT

Returns S_OK if successful, S_FALSE if there are no roots to enumerate, or an error value otherwise.

Remarks

ppSearchRoots is set to NULL if there are no roots to enumerate.

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 with SP1 [desktop apps only]
Target Platform Windows
Header searchapi.h
Redistributable Windows Desktop Search (WDS) 3.0