ISearchScopeRule::get_PatternOrURL method (searchapi.h)

Gets the pattern or URL for the rule. The scope rules determine what URLs or paths to include or exclude.

Syntax

HRESULT get_PatternOrURL(
  [out, retval] LPWSTR *ppszPatternOrURL
);

Parameters

[out, retval] ppszPatternOrURL

Type: LPWSTR*

On return, contains the address of a pointer to a null-terminated, Unicode buffer that contains the pattern or URL string.

Return value

Type: HRESULT

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

Remarks

A standard URL might look like this: outlookexpress://{User sid}/{Identity}/Inbox)

A pattern might look like this: file:///c:\documents and settings*\application data*

Only exclusion rules use patterns.

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