次の方法で共有

PdhGetDefaultPerfCounterHA 関数 (pdh.h)

  • [アーティクル]

指定したオブジェクトの既定のカウンターの名前を取得します。 この名前を使用して、[カウンターの参照] ダイアログ ボックスで最初のカウンターの選択を設定できます。

この関数は PdhGetDefaultPerfCounterと同じですが、データ ソースへのハンドルの使用がサポートされている点が異なります。

構文

PDH_FUNCTION PdhGetDefaultPerfCounterHA(
  [in]      PDH_HLOG hDataSource,
  [in]      LPCSTR   szMachineName,
  [in]      LPCSTR   szObjectName,
  [out]     LPSTR    szDefaultCounterName,
  [in, out] LPDWORD  pcchBufferSize
);

パラメーター

[in] hDataSource

NULLする必要があります。

ログ ファイル ハンドルを指定した場合、szDefaultCounterName は null 文字列になります。

[in] szMachineName

オブジェクト名の検証に使用するコンピューターの名前を指定する null-terminated 文字列です。 NULL場合は、ローカル コンピューターを使用して名前を確認します。

[in] szObjectName

既定のカウンター名を取得するオブジェクトの名前を指定する null-terminated 文字列です。

[out] szDefaultCounterName

null-terminated 既定のカウンター名を受け取る呼び出し元によって割り当てられたバッファー。 pcchBufferSize が 0 の場合 NULL を に設定します。

[in, out] pcchBufferSize

TCHARでの、szDefaultCounterName バッファーのサイズ。 入力時に 0 の場合、関数はPDH_MORE_DATAを返し、このパラメーターを必要なバッファー サイズに設定します。 バッファーが必要なサイズより大きい場合、関数はこのパラメーターを使用したバッファーの実際のサイズに設定します。 入力で指定したサイズが 0 より大きく、必要なサイズより小さい場合は、返されたサイズに依存してバッファーを再割り当てしないでください。

戻り値

関数が成功すると、ERROR_SUCCESSが返されます。

関数が失敗した場合、戻り値は システム エラー コード または PDH エラー コードです。 使用できる値を次に示します。

リターン コード 形容
PDH_MORE_DATA
 szDefaultCounterName バッファーが小さすぎてカウンター名を含められません。 pcchBufferSize が入力時にゼロの場合、この戻り値が予期されます。 入力で指定したサイズが 0 より大きく、必要なサイズより小さい場合は、返されたサイズに依存してバッファーを再割り当てしないでください。
PDH_INVALID_ARGUMENT
 必須パラメーターが無効です。 たとえば、一部のリリースでは、入力で指定されたサイズが 0 より大きく、必要なサイズより小さい場合、このエラーが発生する可能性があります。
PDH_MEMORY_ALLOCATION_FAILURE
 関数を完了するためにメモリを割り当てることができません。
PDH_CSTATUS_NO_MACHINE
 指定されたコンピューターがオフラインであるか、使用できません。
PDH_CSTATUS_NO_COUNTERNAME
 既定のカウンター名は読み取りまたは見つかりません。
PDH_CSTATUS_NO_OBJECT
 指定したオブジェクトが見つかりませんでした。
PDH_CSTATUS_NO_COUNTER
 オブジェクトが既定のカウンターを指定しませんでした。

備考

この関数を 2 回呼び出し、必要なバッファー サイズを取得する場合は 2 回 (szDefaultCounterName を NULL に設定し、pcchBufferSize を 0 に )、2 回目にデータを取得する必要があります。

手記

pdh.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして PdhGetDefaultPerfCounterH を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。

必要条件

要件 価値
サポートされる最小クライアント Windows XP [デスクトップ アプリのみ]
サポートされる最小サーバー Windows Server 2003 [デスクトップ アプリのみ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー pdh.h
ライブラリ Pdh.lib
DLL Pdh.dll

関連項目

PdhBindInputDataSource の

PdhBrowseCountersH

PdhGetDefaultPerfObjectH を する