ISearchNotifyInlineSite::OnCatalogStatusChange method (searchapi.h)

Article
10/13/2021

Called by the search service to notify a client when the status of the catalog changes.

Syntax

HRESULT OnCatalogStatusChange(
  [in] REFGUID guidCatalogResetSignature,
  [in] REFGUID guidCheckPointSignature,
  [in] DWORD   dwLastCheckPointNumber
);

Parameters

[in] guidCatalogResetSignature

Type: REFGUID

A GUID representing the catalog reset. If this GUID changes, all notifications must be resent.

[in] guidCheckPointSignature

Type: REFGUID

A GUID representing the last checkpoint restored. If this GUID changes, all notifications accumulated since the last saved checkpoint must be resent.

[in] dwLastCheckPointNumber

Type: DWORD

A number indicating the last checkpoint saved.

Return value

Type: HRESULT

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

Remarks

When a catalog checkpoint occurs, the search service updates the dwLastCheckPointNumber, and all notifications sent prior to that checkpoint are safe and recoverable in the event of a service failure. Notification providers need to track only those notifications sent between checkpoints and must resend them if the catalog is restored or reset.

If a catalog restore occurs, the search service rolls back the catalog to the last saved checkpoint and updates the guidCheckPointSignature. In this situation, notification providers must resend all notifications accumulated since the most recent saved checkpoint, as identified by the dwLastCheckPointNumber parameter.

If a catalog reset occurs, the search service resets the entire catalog and updates the guidCatalogResetSignature. The notification provider must resend its entire crawl scope.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2, Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	searchapi.h
Redistributable	Windows Desktop Search (WDS) 3.0