PdhCollectQueryData 関数 (pdh.h)
指定したクエリ内のすべてのカウンターの現在の生データ値を収集し、各カウンターの状態コードを更新します。
構文
PDH_FUNCTION PdhCollectQueryData(
[in, out] PDH_HQUERY hQuery
);
パラメーター
[in, out] hQuery
データを収集するクエリのハンドル。 PdhOpenQuery 関数は、このハンドルを返します。
戻り値
関数が成功すると、ERROR_SUCCESSが返されます。 それ以外の場合、関数は システム エラー コード または PDH エラー コードを返します。
使用できる値を次に示します。
リターン コード | 説明 |
---|---|
|
クエリ ハンドルが無効です。 |
|
クエリには現在、カウンターは含まれていません。 ユーザーが昇格されたトークンで実行されていないため、クエリにデータが含まれていない可能性があります ( 「制限付きユーザー アクセス サポート」を参照してください)。 |
注釈
クエリ内のカウンターのカウンター データを収集する場合は、この関数を呼び出します。 PDH は、現在のコレクションと前のコレクションの生カウンター値を格納します。
現在の生カウンター値を取得する場合は、 PdhGetRawCounterValue 関数を呼び出します。 カウンター値の表示可能な値を計算する場合は、 PdhGetFormattedCounterValue 関数を呼び出します。 カウンター パスにインスタンス名のワイルドカードが含まれている場合は、代わりに PdhGetRawCounterArray 関数と PdhGetFormattedCounterArray 関数をそれぞれ呼び出します。
PdhCollectQueryData が 1 つのカウンター インスタンスからのデータに対してのみ呼び出され、カウンター インスタンスが存在しない場合、関数はPDH_NO_DATAを返します。 ただし、複数のカウンターのデータに対してクエリを実行すると、カウンター インスタンスの 1 つが存在しない場合でも、 PdhCollectQueryData はERROR_SUCCESSを返す可能性があります。 これは、指定したカウンター インスタンスが存在しないか、存在するがまだ作成されていないのかが不明であるためです。 この場合は、対象のカウンター インスタンスごとに PdhGetRawCounterValue または PdhGetFormattedCounterValue を呼び出して、それらが存在するかどうかを判断します。
Visual Basic からこの関数を呼び出す場合の構文を次に示します。
PdhCollectQueryData(
ByVal QueryHandle as Long
)
as Long
例
例については、「 パフォーマンス カウンターの参照 」または 「ログ ファイルからのパフォーマンス データの読み取り」を参照してください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows XP (デスクトップ アプリのみ) |
サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
対象プラットフォーム | Windows |
ヘッダー | pdh.h |
Library | Pdh.lib |
[DLL] | Pdh.dll |