ISearchRoot interface (searchapi.h)
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.
Inheritance
The ISearchRoot interface inherits from the IUnknown interface. ISearchRoot also has these types of members:
Methods
The ISearchRoot interface has these methods.
| ISearchRoot::get_AuthenticationType Retrieves the type of authentication needed to access the URLs under this search root. |
| ISearchRoot::get_EnumerationDepth Gets the enumeration depth for this search root. |
| ISearchRoot::get_FollowDirectories Gets a BOOL value that indicates whether the search engine follows subdirectories and hierarchical scopes. |
| ISearchRoot::get_HostDepth Gets a value that indicates how far into a host tree to crawl when indexing. |
| ISearchRoot::get_IsHierarchical Gets a value that indicates whether the search is rooted on a hierarchical tree structure. |
| ISearchRoot::get_Password Not implemented. (ISearchRoot.get_Password) |
| ISearchRoot::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. |
| ISearchRoot::get_RootURL Gets the URL of the starting point for this search root. |
| ISearchRoot::get_Schedule Not implemented. (ISearchRoot.get_Schedule) |
| ISearchRoot::get_UseNotificationsOnly Gets a value that indicates whether this search root should be indexed only by notification and not crawled. |
| ISearchRoot::get_User Not implemented. (ISearchRoot.get_User) |
| ISearchRoot::put_AuthenticationType Sets the type of authentication required to access the URLs under this search root. |
| ISearchRoot::put_EnumerationDepth Sets the enumeration depth for this search root. |
| ISearchRoot::put_FollowDirectories Sets a BOOL value that indicates whether the search engine should follow subdirectories and hierarchical scopes for this search root. |
| ISearchRoot::put_HostDepth Sets a value that indicates how far into a host tree to crawl when indexing. |
| ISearchRoot::put_IsHierarchical Sets a value that indicates whether the search is rooted on a hierarchical tree structure. |
| ISearchRoot::put_Password Not implemented. (ISearchRoot.put_Password) |
| ISearchRoot::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. |
| ISearchRoot::put_RootURL Sets the URL of the current search root. |
| ISearchRoot::put_Schedule Not implemented. (ISearchRoot.put_Schedule) |
| ISearchRoot::put_UseNotificationsOnly Sets a value that indicates whether this search root should be indexed only by notification and not crawled. |
| ISearchRoot::put_User Not implemented. (ISearchRoot.put_User) |
Remarks
For a sample that demonstrates how to define command line options for Crawl Scope Manager (CSM) indexing operations, see the CrawlScopeCommandLine sample.
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 |