ISearchCatalogManager::GetCatalogStatus メソッド (searchapi.h)

カタログの状態を取得します。

構文

HRESULT GetCatalogStatus(
  [out] CatalogStatus       *pStatus,
  [out] CatalogPausedReason *pPausedReason
);

パラメーター

[out] pStatus

種類: CatalogStatus*

CatalogStatus 列挙から値へのポインターを受け取ります。 pStatus がCATALOG_STATUS_PAUSEDされている場合は、pPausedReason パラメーターからさらに情報を取得できます。

[out] pPausedReason

種類: CatalogPausedReason*

カタログが一時停止されている理由を説明する CatalogPausedReason 列挙から値へのポインターを受け取ります。 カタログの状態が CATALOG_STATUS_PAUSEDされていない場合、このパラメーターは CATALOG_PAUSED_REASON_NONE値を受け取ります。

戻り値

型: HRESULT

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

要件

要件	値
サポートされている最小のクライアント	WINDOWS XP と SP2、Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2003 SP1 [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	searchapi.h
再頒布可能パッケージ	Windows デスクトップ検索 (WDS) 3.0