ISearchCatalogManager::GetCatalogStatus method (searchapi.h)
Gets the status of the catalog.
Syntax
HRESULT GetCatalogStatus(
[out] CatalogStatus *pStatus,
[out] CatalogPausedReason *pPausedReason
);
Parameters
[out] pStatus
Type: CatalogStatus*
Receives a pointer to a value from the CatalogStatus enumeration. If pStatus is CATALOG_STATUS_PAUSED, further information can be obtained from the pPausedReason parameter.
[out] pPausedReason
Type: CatalogPausedReason*
Receives a pointer to a value from the CatalogPausedReason enumeration describing why the catalog is paused. If the catalog status is not CATALOG_STATUS_PAUSED, this parameter receives the value CATALOG_PAUSED_REASON_NONE.
Return value
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows XP with SP2, Windows Vista [desktop apps only] |
Minimum supported server | Windows Server 2003 with SP1 [desktop apps only] |
Target Platform | Windows |
Header | searchapi.h |
Redistributable | Windows Desktop Search (WDS) 3.0 |