IRowsetEvents::OnDeletedItem method (searchapi.h)

Article
02/22/2024

Called by the indexer to notify clients that an item has been deleted. This item may have matched some (or all) of the search criteria for the client rowset.

Syntax

HRESULT OnDeletedItem(
  [in] REFPROPVARIANT        itemID,
  [in] ROWSETEVENT_ITEMSTATE deletedItemState
);

Parameters

[in] itemID

Type: REFPROPVARIANT

Specifies the item in the rowset that has been deleted.

[in] deletedItemState

Type: ROWSETEVENT_ITEMSTATE

Specifies whether the deleted item is currently in the rowset, as a ROWSETEVENT_ITEMSTATE enumeration.

Return value

Type: HRESULT

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

Remarks

The ROWSETEVENT_ITEMSTATE indicates whether or not the item was contained in the original rowset:

ROWSETEVENT_ITEMSTATE_INROWSET indicates that the deleted item is definitely in your rowset.
ROWSETEVENT_ITEMSTATE_UNKNOWN indicates that the deleted item may be in your rowset. The containment status is not known because your rowset is not fully evaluated.
ROWSETEVENT_ITEMSTATE_NOTINROWSET indicates the deleted item was definitely not in your original rowset (but may have already been given via an OnNewItem or OnChangedItem event).

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	searchapi.h