PdhGetDefaultPerfCounterA 関数 (pdh.h)

  • [アーティクル]

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

データ ソースにハンドルを使用するには、 PdhGetDefaultPerfCounterH 関数を 使用します。

構文

PDH_FUNCTION PdhGetDefaultPerfCounterA(
  [in]      LPCSTR  szDataSource,
  [in]      LPCSTR  szMachineName,
  [in]      LPCSTR  szObjectName,
  [out]     LPSTR   szDefaultCounterName,
  [in, out] LPDWORD pcchBufferSize
);

パラメーター

[in] szDataSource

NULL にする必要があります。

ログ ファイルを指定すると、 szDefaultCounterName は null 文字列になります。

[in] szMachineName

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

[in] szObjectName

取得する既定のカウンター名を持つオブジェクトの名前を指定する Null で終わる文字列。

[out] szDefaultCounterName

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

[in, out] pcchBufferSize

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

戻り値

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

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

リターン コード 説明
PDH_MORE_DATA
 szDefaultCounterName バッファーが小さすぎてカウンター名を含められません。 この戻り値は、入力時 に pcchBufferSize が 0 の場合に予期されます。 入力で指定したサイズが 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 回呼び出す必要があります。最初に必要なバッファー サイズを取得し ( szDefaultCounterName を NULL に、 pcchBufferSize を 0 に設定)、2 回目にデータを取得します。

注意

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

要件

要件 値
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー pdh.h
Library Pdh.lib
[DLL] Pdh.dll

こちらもご覧ください

PdhGetDefaultPerfCounterH

PdhGetDefaultPerfObject