ホーム › System.Performance › PdhGetDefaultPerfCounterA

PdhGetDefaultPerfCounterA

関数

オブジェクトの既定カウンター名を取得する(ANSI版)。

DLLpdh.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// pdh.dll  (ANSI / -A)
#include <windows.h>

DWORD PdhGetDefaultPerfCounterA(
    LPCSTR szDataSource,   // optional
    LPCSTR szMachineName,   // optional
    LPCSTR szObjectName,
    LPSTR szDefaultCounterName,   // optional
    DWORD* pcchBufferSize
);

パラメーター

名前	型	方向	説明
szDataSource	LPCSTR	inoptional	NULL を指定してください。ログファイルを指定した場合、szDefaultCounterName は null 文字列になります。
szMachineName	LPCSTR	inoptional	オブジェクト名の検証に使用するコンピューターの名前を指定する null 終端文字列です。NULL の場合、ローカルコンピューターを使用してオブジェクト名を検証します。
szObjectName	LPCSTR	in	既定のカウンター名を取得する対象オブジェクトの名前を指定する null 終端文字列です。
szDefaultCounterName	LPSTR	outoptional	null 終端の既定のカウンター名を受け取る、呼び出し側が割り当てたバッファーです。pcchBufferSize が 0 の場合は NULL を設定してください。
pcchBufferSize	DWORD*	inout	szDefaultCounterName バッファーのサイズ (TCHAR 単位)。入力時に 0 の場合、関数は PDH_MORE_DATA を返し、このパラメーターに必要なバッファーサイズを設定します。バッファーが必要なサイズより大きい場合、関数はこのパラメーターに実際に使用されたバッファーサイズを設定します。入力時に指定したサイズが 0 より大きく必要なサイズより小さい場合、返されたサイズを基にバッファーを再割り当てしないでください。

戻り値の型: DWORD

公式ドキュメント

指定したオブジェクトの既定のカウンター名を取得します。この名前は、[カウンターの参照] ダイアログボックスで初期のカウンター選択を設定するために使用できます。データソースのハンドルを使用する場合は、PdhGetDefaultPerfCounterH 関数を使用してください。(ANSI)

戻り値

関数が成功した場合は 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	オブジェクトに既定のカウンターが指定されていません。

解説(Remarks)

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

メモ

pdh.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして PdhGetDefaultPerfCounter を定義しています。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// pdh.dll  (ANSI / -A)
#include <windows.h>

DWORD PdhGetDefaultPerfCounterA(
    LPCSTR szDataSource,   // optional
    LPCSTR szMachineName,   // optional
    LPCSTR szObjectName,
    LPSTR szDefaultCounterName,   // optional
    DWORD* pcchBufferSize
);

[DllImport("pdh.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint PdhGetDefaultPerfCounterA(
    [MarshalAs(UnmanagedType.LPStr)] string szDataSource,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string szMachineName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string szObjectName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szDefaultCounterName,   // LPSTR optional, out
    ref uint pcchBufferSize   // DWORD* in/out
);

<DllImport("pdh.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PdhGetDefaultPerfCounterA(
    <MarshalAs(UnmanagedType.LPStr)> szDataSource As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> szMachineName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> szObjectName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szDefaultCounterName As System.Text.StringBuilder,   ' LPSTR optional, out
    ByRef pcchBufferSize As UInteger   ' DWORD* in/out
) As UInteger
End Function

' szDataSource : LPCSTR optional
' szMachineName : LPCSTR optional
' szObjectName : LPCSTR
' szDefaultCounterName : LPSTR optional, out
' pcchBufferSize : DWORD* in/out
Declare PtrSafe Function PdhGetDefaultPerfCounterA Lib "pdh" ( _
    ByVal szDataSource As String, _
    ByVal szMachineName As String, _
    ByVal szObjectName As String, _
    ByVal szDefaultCounterName As String, _
    ByRef pcchBufferSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhGetDefaultPerfCounterA = ctypes.windll.pdh.PdhGetDefaultPerfCounterA
PdhGetDefaultPerfCounterA.restype = wintypes.DWORD
PdhGetDefaultPerfCounterA.argtypes = [
    wintypes.LPCSTR,  # szDataSource : LPCSTR optional
    wintypes.LPCSTR,  # szMachineName : LPCSTR optional
    wintypes.LPCSTR,  # szObjectName : LPCSTR
    wintypes.LPSTR,  # szDefaultCounterName : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchBufferSize : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhGetDefaultPerfCounterA = Fiddle::Function.new(
  lib['PdhGetDefaultPerfCounterA'],
  [
    Fiddle::TYPE_VOIDP,  # szDataSource : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # szMachineName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # szObjectName : LPCSTR
    Fiddle::TYPE_VOIDP,  # szDefaultCounterName : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchBufferSize : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhGetDefaultPerfCounterA(
        szDataSource: *const u8,  // LPCSTR optional
        szMachineName: *const u8,  // LPCSTR optional
        szObjectName: *const u8,  // LPCSTR
        szDefaultCounterName: *mut u8,  // LPSTR optional, out
        pcchBufferSize: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("pdh.dll", CharSet = CharSet.Ansi)]
public static extern uint PdhGetDefaultPerfCounterA([MarshalAs(UnmanagedType.LPStr)] string szDataSource, [MarshalAs(UnmanagedType.LPStr)] string szMachineName, [MarshalAs(UnmanagedType.LPStr)] string szObjectName, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szDefaultCounterName, ref uint pcchBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhGetDefaultPerfCounterA' -Namespace Win32 -PassThru
# $api::PdhGetDefaultPerfCounterA(szDataSource, szMachineName, szObjectName, szDefaultCounterName, pcchBufferSize)

#uselib "pdh.dll"
#func global PdhGetDefaultPerfCounterA "PdhGetDefaultPerfCounterA" sptr, sptr, sptr, sptr, sptr
; PdhGetDefaultPerfCounterA szDataSource, szMachineName, szObjectName, varptr(szDefaultCounterName), varptr(pcchBufferSize)   ; 戻り値は stat
; szDataSource : LPCSTR optional -> "sptr"
; szMachineName : LPCSTR optional -> "sptr"
; szObjectName : LPCSTR -> "sptr"
; szDefaultCounterName : LPSTR optional, out -> "sptr"
; pcchBufferSize : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "pdh.dll"
#cfunc global PdhGetDefaultPerfCounterA "PdhGetDefaultPerfCounterA" str, str, str, var, var
; res = PdhGetDefaultPerfCounterA(szDataSource, szMachineName, szObjectName, szDefaultCounterName, pcchBufferSize)
; szDataSource : LPCSTR optional -> "str"
; szMachineName : LPCSTR optional -> "str"
; szObjectName : LPCSTR -> "str"
; szDefaultCounterName : LPSTR optional, out -> "var"
; pcchBufferSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "pdh.dll"
#cfunc global PdhGetDefaultPerfCounterA "PdhGetDefaultPerfCounterA" str, str, str, sptr, sptr
; res = PdhGetDefaultPerfCounterA(szDataSource, szMachineName, szObjectName, varptr(szDefaultCounterName), varptr(pcchBufferSize))
; szDataSource : LPCSTR optional -> "str"
; szMachineName : LPCSTR optional -> "str"
; szObjectName : LPCSTR -> "str"
; szDefaultCounterName : LPSTR optional, out -> "sptr"
; pcchBufferSize : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。