ISearchItemsChangedSink::StartedMonitoringScope method (searchapi.h)

Article
02/22/2024

Permits an index-managed notification source to add itself to a list of "monitored scopes".

Syntax

HRESULT StartedMonitoringScope(
  [in] LPCWSTR pszURL
);

Parameters

[in] pszURL

Type: LPCWSTR

A pointer to a null-terminated, Unicode string that is the start address for the scope of monitoring.

Return value

Type: HRESULT

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

Remarks

When a notification agent comes online it calls StartedMonitoringScope which adds the scope to the list of sources. If the source is new (removed previously by StoppedMonitoringScope, or never created in the first place) the indexer starts an incremental crawl of the corresponding document store. This is designed to pick up any changes in the store that occurred while the notification agent was offline.

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