ISearchItemsChangedSink::OnItemsChanged method (searchapi.h)

Article
10/13/2021

Call this method to notify an indexer to re-index some changed items.

Syntax

HRESULT OnItemsChanged(
  [in]  DWORD                 dwNumberOfChanges,
  [in]  SEARCH_ITEM_CHANGE [] rgDataChangeEntries,
  [out] DWORD []              rgdwDocIds,
  [out] HRESULT []            rghrCompletionCodes
);

Parameters

[in] dwNumberOfChanges

Type: DWORD

The number of items that have changed.

[in] rgDataChangeEntries

Type: SEARCH_ITEM_CHANGE[]

An array of SEARCH_ITEM_CHANGE structures, describing the type of changes to and the paths or URLs of each item.

[out] rgdwDocIds

Type: DWORD[]

Receives a pointer to an array of document identifiers for the items that changed.

[out] rghrCompletionCodes

Type: HRESULT[]

Receives a pointer to an array of completion codes for rgdwDocIds indicating whether each item was accepted for indexing.

Return value

Type: HRESULT

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

Remarks

When there are multiple change notifications, the priority member of the SEARCH_ITEM_CHANGE structure indicates the priority of processing.

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

Share via