ISearchCrawlScopeManager::IncludedInCrawlScopeEx Method

  • Article

Retrieves an indicator of whether and why the specified URL is included in the crawl scope.

Syntax

HRESULT IncludedInCrawlScopeEx(      
    LPCWSTR pszURL,
    BOOL *pfIsIncluded,
    CLUSION_REASON *pReason
);

Parameters

  • pszURL
    [in] A string value indicating the URL to check for inclusion in the crawl scope.
  • pfIsIncluded
    [out, retval] A pointer to a BOOL value: TRUE if pszURL is included in the crawl scope; otherwise, FALSE.
  • pReason
    [out] 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

Returns S_OK if successful, or an error value otherwise.

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: 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.