ISearchCrawlScopeManager::IncludedInCrawlScopeEx method (searchapi.h)
Retrieves an indicator of whether and why the specified URL is included in the crawl scope.
Syntax
HRESULT IncludedInCrawlScopeEx(
[in] LPCWSTR pszURL,
[out] BOOL *pfIsIncluded,
[out] CLUSION_REASON *pReason
);
Parameters
[in] pszURL
Type: LPCWSTR
A string value indicating the URL to check for inclusion in the crawl scope.
[out] pfIsIncluded
Type: BOOL*
A pointer to a BOOL value: TRUE if pszURL is included in the crawl scope; otherwise, FALSE.
[out] pReason
Type: CLUSION_REASON*
Retrieves a pointer to a value from the CLUSION_REASON enumeration that indicates the reason that the specified URL was included in or excluded from the crawl scope.
Return value
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Remarks
For hierarchical sources, the most immediate parent is included. For non-hierarchical sources like URLs, this will be only the URL rule itself. Other URLs that might be indexed will cause this method to retrieve FALSE because there is no way to tell whether they are in the scope.
<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 |