Edit

Share via

ISearchScopeRule::get_IsIncluded method (searchapi.h)

  • Article

Gets a value identifying whether this rule is an inclusion rule. Inclusion rules identify scopes that should be included in the crawl scope.

Syntax

HRESULT get_IsIncluded(
  [out, retval] BOOL *pfIsIncluded
);

Parameters

[out, retval] pfIsIncluded

Type: BOOL*

On return, points to TRUE if this rule is an inclusion rule, FALSE otherwise.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

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