Export (0) Print
Expand All

ROWSETEVENT_TYPE enumeration

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

Syntax


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

Constants

ROWSETEVENT_TYPE_DATAEXPIRED

Indicates that data backing the rowset has expired, and that a new rowset should be requested.

ROWSETEVENT_TYPE_FOREGROUNDLOST

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

Indicates that the scope statistics are to be optained.

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.

The SearchEvents code sample, available on Code Gallery and the Windows 7 SDK, demonstrates how to prioritize indexing events.

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Searchapi.h

IDL

Searchquery.idl

See also

Reference
IRowsetPrioritization
PRIORITY_LEVEL
PRIORITIZE_FLAGS
ROWSETEVENT_ITEMSTATE
Rowset Properties
Conceptual
Indexing Prioritization and Rowset Events in Windows 7
Notifications Process (Windows Search)

 

 

Community Additions

ADD
Show:
© 2014 Microsoft