IRowsetPrioritization::GetScopeStatistics method (searchapi.h)

Gets information describing the scope specified by this query.

Syntax

HRESULT GetScopeStatistics(
  [out] DWORD *indexedDocumentCount,
  [out] DWORD *oustandingAddCount,
  [out] DWORD *oustandingModifyCount
);

Parameters

[out] indexedDocumentCount

Type: DWORD*

The total number of documents currently indexed in the scope.

[out] oustandingAddCount

Type: DWORD*

The total number of documents yet to be indexed in the scope. These documents are not yet included in indexedDocumentCount.

[out] oustandingModifyCount

Type: DWORD*

The total number of documents indexed in the scope that need to be re-indexed. These documents are included in indexedDocumentCount.

Return value

Type: HRESULT

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

Remarks

Returns S_OK if successful, HRESULT_FROM_WIN32(ERROR_PATH_NOT_FOUND) if there are no indexed documents in the scope, or an error value otherwise.

The GetScopeStatistics event can be used to get the number of indexed items in the scope, the number of outstanding docs to be added in the scope, and the number of docs that need to be re-indexed within this scope.

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]
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