IRowsetEvents::OnNewItem method (searchapi.h)

Called by the indexer to notify clients of a new item that may match some (or all) of the criteria for the client rowset.

Syntax

HRESULT OnNewItem(
  [in] REFPROPVARIANT        itemID,
  [in] ROWSETEVENT_ITEMSTATE newItemState
);

Parameters

[in] itemID

Type: REFPROPVARIANT

The new item that may match the original search criteria of the rowset.

[in] newItemState

Type: ROWSETEVENT_ITEMSTATE

Specifies whether the new item matches all or some of the criteria for your 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 the degree to which the new item may match the original search criteria of a rowset:

  • ROWSETEVENT_ITEMSTATE_INROWSET indicates that the new item definitely matches all criteria for your rowset.
  • ROWSETEVENT_ITEMSTATE_UNKNOWN indicates that the new item at least partially matches some criteria for your rowset. It may match fully.
  • ROWSETEVENT_ITEMSTATE_NOTINROWSET is not applicable for new items.

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

See also

Conceptual

IRowsetEvents

IRowsetPrioritization

Indexing Prioritization and Rowset Events in Windows 7

PRIORITIZE_FLAGS

PRIORITY_LEVEL

ROWSETEVENT_ITEMSTATE

ROWSETEVENT_TYPE

Reference

Rowset Properties