ISearchRoot Interface

Provides methods for manipulating a search root. Changes to property members are applied to any URL that falls under the search root. A URL falls under a search root if it matches the search root URL or is a hierarchical child of that URL.

ISearchRoot Members

get_AuthenticationType Retrieves the type of authentication needed to access the URLs under this this search root.
get_EnumerationDepth Gets the enumeration depth for this search root.
get_FollowDirectories Gets a BOOL value that indicates whether the search engine follows subdirectories and hierarchical scopes.
get_HostDepth Gets a value that indicates how far into a host tree to crawl when indexing.
get_IsHierarchical Gets a value that indicates whether the search is rooted on a hierarchical tree structure.
get_Password Not implemented.
get_ProvidesNotifications Gets a value that indicates whether the search engine is notified (by protocol handlers or other applications) about changes to the URLs under the search root.
get_RootURL Gets the URL of the starting point for this search root.
get_Schedule Not implemented.
get_UseNotificationsOnly Gets a value that indicates whether this search root should be indexed only by notification and not crawled.
get_User Not implemented.
put_AuthenticationType Sets the type of authentication required to access the URLs under this search root.
put_EnumerationDepth Sets the enumeration depth for this search root.
put_FollowDirectories Sets a BOOL value that indicates whether the search engine should follow subdirectories and hierarchical scopes for this search root.
put_HostDepth Sets a value that indicates how far into a host tree to crawl when indexing.
put_IsHierarchical Sets a value that indicates whether the search is rooted on a hierarchical tree structure.
put_Password Not implemented.
put_ProvidesNotifications Sets a value that indicates whether the search engine is notified (by protocol handlers or other applications) about changes to the URLs under the search root.
put_RootURL Sets the URL of the current search root.
put_Schedule Not implemented.
put_User Not implemented.
set_UseNotificationsOnly Sets a value that indicates whether this search root should be indexed only by notification and not crawled.

Remarks

The CrawlScopeCommandLine code sample, available on Code Gallery and the Windows 7 SDK, demonstrates how to define command line options for Crawl Scope Manager (CSM) indexing operations.

Interface Information

Inherits from IUnknown
Header searchapi.h
Minimum operating systems Windows XP Service Pack 2 (SP2) with Windows Desktop Search (WDS) 3.0, Windows Server 2003 Service Pack 1 (SP1) with Windows Desktop Search (WDS) 3.0, Windows Vista

See Also

Using the Crawl Scope Manager