Edit

ROWSETEVENT_TYPE enumeration (searchapi.h)

  • Article

Describes the type of change to the rowset's data.

Syntax

typedef enum __MIDL___MIDL_itf_searchapi_0000_0023_0002 {
  ROWSETEVENT_TYPE_DATAEXPIRED = 0,
  ROWSETEVENT_TYPE_FOREGROUNDLOST = 1,
  ROWSETEVENT_TYPE_SCOPESTATISTICS = 2
} ROWSETEVENT_TYPE;

Constants

 
ROWSETEVENT_TYPE_DATAEXPIRED
Value: 0
Indicates that data backing the rowset has expired, and that a new rowset should be requested.
ROWSETEVENT_TYPE_FOREGROUNDLOST
Value: 1
Indicates that an item that did have foreground priority in the prioritization stack has been demoted, because someone else prioritized themselves ahead of this query.
ROWSETEVENT_TYPE_SCOPESTATISTICS
Value: 2
Indicates that the scope statistics are to be obtained.

Remarks

This enumeration is used in the IRowsetEvents::OnRowsetEvent method to describe the type of event that affects a rowset.

The ROWSETEVENT_TYPE_SCOPESTATISTICS event gives you the same information available from the IRowsetPrioritization::GetScopeStatistics method call, but through a push mechanic, as follows:

  • The event arises if the prioritization API has been used to request a non-default prioritization level, and a non-zero statistics event frequency.
  • The event arises only when statistics actually change, and the interval specified in the IRowsetPrioritization has elapsed (the interval does not guarantee the frequency of the event).
  • This event is guaranteed to raise a "bounce zero" state (zero items remaining to be added, zero modifies remaining), provided that a non-zero event has been raised.
  • The indexer may process items without sending this event, if the queue empties before the statistics event frequency.
Check out the SearchEvents code sample.

Requirements

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

See also

Conceptual

IRowsetPrioritization

Indexing Prioritization and Rowset Events in Windows 7

Notifications Process (Windows Search)

PRIORITIZE_FLAGS

PRIORITY_LEVEL

ROWSETEVENT_ITEMSTATE

Reference

Rowset Properties