Win32 API 日本語リファレンス
ホーム › System.Performance › PdhAddCounterA

PdhAddCounterA

関数
照会にカウンターパスを指定して追加する(ANSI版)。
DLLpdh.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

DWORD PdhAddCounterA(
    PDH_HQUERY hQuery,
    LPCSTR szFullCounterPath,
    UINT_PTR dwUserData,
    PDH_HCOUNTER* phCounter
);

パラメーター

名前型方向説明
hQueryPDH_HQUERYinカウンターを追加するクエリへのハンドルです。このハンドルは PdhOpenQuery 関数によって返されます。
szFullCounterPathLPCSTRinカウンターパスを含む、null で終わる文字列です。カウンターパスの形式の詳細については、 Specifying a Counter Path を参照してください。カウンターパスの最大長は PDH_MAX_COUNTER_PATH です。
dwUserDataUINT_PTRinユーザー定義の値です。この値はカウンター情報の一部になります。後でこの値を取得するには、PdhGetCounterInfo 関数を呼び出し、PDH_COUNTER_INFO 構造体の dwUserData メンバーにアクセスします。
phCounterPDH_HCOUNTER*outクエリに追加されたカウンターへのハンドルです。後続の呼び出しでこのハンドルを参照する必要がある場合があります。

戻り値の型: DWORD

公式ドキュメント

指定したカウンターをクエリに追加します。(ANSI)

戻り値

関数が成功した場合は ERROR_SUCCESS を返します。

関数が失敗した場合、戻り値は システムエラーコードまたは PDH エラーコードです。次の値が返される可能性があります。

戻り値 説明
PDH_CSTATUS_BAD_COUNTERNAME
 カウンターパスを解析または解釈できませんでした。
PDH_CSTATUS_NO_COUNTER
 指定したカウンターをコンピューター上またはログファイル内で見つけられませんでした。
PDH_CSTATUS_NO_COUNTERNAME
 カウンターパスが空です。
PDH_CSTATUS_NO_MACHINE
 パスにコンピューター名が含まれておらず、関数がローカルコンピューター名を取得できませんでした。
PDH_CSTATUS_NO_OBJECT
 指定したオブジェクトをコンピューター上またはログファイル内で見つけられませんでした。
PDH_FUNCTION_NOT_FOUND
 このカウンターに使用する計算関数を特定できませんでした。
PDH_INVALID_ARGUMENT
 1 つ以上の引数が無効です。
PDH_INVALID_HANDLE
 クエリハンドルが無効です。
PDH_MEMORY_ALLOCATION_FAILURE
 関数の完了に必要なメモリを割り当てられませんでした。

解説(Remarks)

カウンターパスにワイルドカード文字が含まれている場合、そのワイルドカード文字に一致するすべてのカウンター名がクエリに追加されます。

まだ存在しないカウンターインスタンスが指定された場合でも、 PdhAddCounter はエラー条件を報告しません。代わりに ERROR_SUCCESS を返します。この動作の理由は、存在しないカウンターインスタンスが指定されたのか、あるいは今後存在するがまだ作成されていないインスタンスが指定されたのかを判別できないためです。

クエリからカウンターを削除するには、 PdhRemoveCounter 関数を使用します。

例

例については、 Browsing Performance Counters または Reading Performance Data from a Log File を参照してください。

メモ

pdh.h ヘッダーは PdhAddCounter を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存ではないコードと混在して使用すると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PdhAddCounterA(
    PDH_HQUERY hQuery,
    LPCSTR szFullCounterPath,
    UINT_PTR dwUserData,
    PDH_HCOUNTER* phCounter
);
[DllImport("pdh.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint PdhAddCounterA(
    IntPtr hQuery,   // PDH_HQUERY
    [MarshalAs(UnmanagedType.LPStr)] string szFullCounterPath,   // LPCSTR
    UIntPtr dwUserData,   // UINT_PTR
    IntPtr phCounter   // PDH_HCOUNTER* out
);
<DllImport("pdh.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PdhAddCounterA(
    hQuery As IntPtr,   ' PDH_HQUERY
    <MarshalAs(UnmanagedType.LPStr)> szFullCounterPath As String,   ' LPCSTR
    dwUserData As UIntPtr,   ' UINT_PTR
    phCounter As IntPtr   ' PDH_HCOUNTER* out
) As UInteger
End Function
' hQuery : PDH_HQUERY
' szFullCounterPath : LPCSTR
' dwUserData : UINT_PTR
' phCounter : PDH_HCOUNTER* out
Declare PtrSafe Function PdhAddCounterA Lib "pdh" ( _
    ByVal hQuery As LongPtr, _
    ByVal szFullCounterPath As String, _
    ByVal dwUserData As LongPtr, _
    ByVal phCounter As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PdhAddCounterA = ctypes.windll.pdh.PdhAddCounterA
PdhAddCounterA.restype = wintypes.DWORD
PdhAddCounterA.argtypes = [
    wintypes.HANDLE,  # hQuery : PDH_HQUERY
    wintypes.LPCSTR,  # szFullCounterPath : LPCSTR
    ctypes.c_size_t,  # dwUserData : UINT_PTR
    ctypes.c_void_p,  # phCounter : PDH_HCOUNTER* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhAddCounterA = Fiddle::Function.new(
  lib['PdhAddCounterA'],
  [
    Fiddle::TYPE_VOIDP,  # hQuery : PDH_HQUERY
    Fiddle::TYPE_VOIDP,  # szFullCounterPath : LPCSTR
    Fiddle::TYPE_UINTPTR_T,  # dwUserData : UINT_PTR
    Fiddle::TYPE_VOIDP,  # phCounter : PDH_HCOUNTER* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "pdh")]
extern "system" {
    fn PdhAddCounterA(
        hQuery: *mut core::ffi::c_void,  // PDH_HQUERY
        szFullCounterPath: *const u8,  // LPCSTR
        dwUserData: usize,  // UINT_PTR
        phCounter: *mut *mut core::ffi::c_void  // PDH_HCOUNTER* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("pdh.dll", CharSet = CharSet.Ansi)]
public static extern uint PdhAddCounterA(IntPtr hQuery, [MarshalAs(UnmanagedType.LPStr)] string szFullCounterPath, UIntPtr dwUserData, IntPtr phCounter);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhAddCounterA' -Namespace Win32 -PassThru
# $api::PdhAddCounterA(hQuery, szFullCounterPath, dwUserData, phCounter)
#uselib "pdh.dll"
#func global PdhAddCounterA "PdhAddCounterA" sptr, sptr, sptr, sptr
; PdhAddCounterA hQuery, szFullCounterPath, dwUserData, phCounter   ; 戻り値は stat
; hQuery : PDH_HQUERY -> "sptr"
; szFullCounterPath : LPCSTR -> "sptr"
; dwUserData : UINT_PTR -> "sptr"
; phCounter : PDH_HCOUNTER* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "pdh.dll"
#cfunc global PdhAddCounterA "PdhAddCounterA" sptr, str, sptr, sptr
; res = PdhAddCounterA(hQuery, szFullCounterPath, dwUserData, phCounter)
; hQuery : PDH_HQUERY -> "sptr"
; szFullCounterPath : LPCSTR -> "str"
; dwUserData : UINT_PTR -> "sptr"
; phCounter : PDH_HCOUNTER* out -> "sptr"
; DWORD PdhAddCounterA(PDH_HQUERY hQuery, LPCSTR szFullCounterPath, UINT_PTR dwUserData, PDH_HCOUNTER* phCounter)
#uselib "pdh.dll"
#cfunc global PdhAddCounterA "PdhAddCounterA" intptr, str, intptr, intptr
; res = PdhAddCounterA(hQuery, szFullCounterPath, dwUserData, phCounter)
; hQuery : PDH_HQUERY -> "intptr"
; szFullCounterPath : LPCSTR -> "str"
; dwUserData : UINT_PTR -> "intptr"
; phCounter : PDH_HCOUNTER* out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	pdh = windows.NewLazySystemDLL("pdh.dll")
	procPdhAddCounterA = pdh.NewProc("PdhAddCounterA")
)

// hQuery (PDH_HQUERY), szFullCounterPath (LPCSTR), dwUserData (UINT_PTR), phCounter (PDH_HCOUNTER* out)
r1, _, err := procPdhAddCounterA.Call(
	uintptr(hQuery),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szFullCounterPath))),
	uintptr(dwUserData),
	uintptr(phCounter),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function PdhAddCounterA(
  hQuery: THandle;   // PDH_HQUERY
  szFullCounterPath: PAnsiChar;   // LPCSTR
  dwUserData: NativeUInt;   // UINT_PTR
  phCounter: Pointer   // PDH_HCOUNTER* out
): DWORD; stdcall;
  external 'pdh.dll' name 'PdhAddCounterA';
result := DllCall("pdh\PdhAddCounterA"
    , "Ptr", hQuery   ; PDH_HQUERY
    , "AStr", szFullCounterPath   ; LPCSTR
    , "UPtr", dwUserData   ; UINT_PTR
    , "Ptr", phCounter   ; PDH_HCOUNTER* out
    , "UInt")   ; return: DWORD
●PdhAddCounterA(hQuery, szFullCounterPath, dwUserData, phCounter) = DLL("pdh.dll", "dword PdhAddCounterA(void*, char*, int, void*)")
# 呼び出し: PdhAddCounterA(hQuery, szFullCounterPath, dwUserData, phCounter)
# hQuery : PDH_HQUERY -> "void*"
# szFullCounterPath : LPCSTR -> "char*"
# dwUserData : UINT_PTR -> "int"
# phCounter : PDH_HCOUNTER* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "pdh" fn PdhAddCounterA(
    hQuery: ?*anyopaque, // PDH_HQUERY
    szFullCounterPath: [*c]const u8, // LPCSTR
    dwUserData: usize, // UINT_PTR
    phCounter: ?*anyopaque // PDH_HCOUNTER* out
) callconv(std.os.windows.WINAPI) u32;
proc PdhAddCounterA(
    hQuery: pointer,  # PDH_HQUERY
    szFullCounterPath: cstring,  # LPCSTR
    dwUserData: uint,  # UINT_PTR
    phCounter: pointer  # PDH_HCOUNTER* out
): uint32 {.importc: "PdhAddCounterA", stdcall, dynlib: "pdh.dll".}
pragma(lib, "pdh");
extern(Windows)
uint PdhAddCounterA(
    void* hQuery,   // PDH_HQUERY
    const(char)* szFullCounterPath,   // LPCSTR
    size_t dwUserData,   // UINT_PTR
    void* phCounter   // PDH_HCOUNTER* out
);
ccall((:PdhAddCounterA, "pdh.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cstring, Csize_t, Ptr{Cvoid}),
      hQuery, szFullCounterPath, dwUserData, phCounter)
# hQuery : PDH_HQUERY -> Ptr{Cvoid}
# szFullCounterPath : LPCSTR -> Cstring
# dwUserData : UINT_PTR -> Csize_t
# phCounter : PDH_HCOUNTER* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t PdhAddCounterA(
    void* hQuery,
    const char* szFullCounterPath,
    uintptr_t dwUserData,
    void* phCounter);
]]
local pdh = ffi.load("pdh")
-- pdh.PdhAddCounterA(hQuery, szFullCounterPath, dwUserData, phCounter)
-- hQuery : PDH_HQUERY
-- szFullCounterPath : LPCSTR
-- dwUserData : UINT_PTR
-- phCounter : PDH_HCOUNTER* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('pdh.dll');
const PdhAddCounterA = lib.func('__stdcall', 'PdhAddCounterA', 'uint32_t', ['void *', 'str', 'uintptr_t', 'void *']);
// PdhAddCounterA(hQuery, szFullCounterPath, dwUserData, phCounter)
// hQuery : PDH_HQUERY -> 'void *'
// szFullCounterPath : LPCSTR -> 'str'
// dwUserData : UINT_PTR -> 'uintptr_t'
// phCounter : PDH_HCOUNTER* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("pdh.dll", {
  PdhAddCounterA: { parameters: ["pointer", "buffer", "usize", "pointer"], result: "u32" },
});
// lib.symbols.PdhAddCounterA(hQuery, szFullCounterPath, dwUserData, phCounter)
// hQuery : PDH_HQUERY -> "pointer"
// szFullCounterPath : LPCSTR -> "buffer"
// dwUserData : UINT_PTR -> "usize"
// phCounter : PDH_HCOUNTER* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t PdhAddCounterA(
    void* hQuery,
    const char* szFullCounterPath,
    size_t dwUserData,
    void* phCounter);
C, "pdh.dll");
// $ffi->PdhAddCounterA(hQuery, szFullCounterPath, dwUserData, phCounter);
// hQuery : PDH_HQUERY
// szFullCounterPath : LPCSTR
// dwUserData : UINT_PTR
// phCounter : PDH_HCOUNTER* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Pdh extends StdCallLibrary {
    Pdh INSTANCE = Native.load("pdh", Pdh.class, W32APIOptions.ASCII_OPTIONS);
    int PdhAddCounterA(
        Pointer hQuery,   // PDH_HQUERY
        String szFullCounterPath,   // LPCSTR
        long dwUserData,   // UINT_PTR
        Pointer phCounter   // PDH_HCOUNTER* out
    );
}
@[Link("pdh")]
lib Libpdh
  fun PdhAddCounterA = PdhAddCounterA(
    hQuery : Void*,   # PDH_HQUERY
    szFullCounterPath : UInt8*,   # LPCSTR
    dwUserData : LibC::SizeT,   # UINT_PTR
    phCounter : Void*   # PDH_HCOUNTER* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PdhAddCounterANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, UintPtr, Pointer<Void>);
typedef PdhAddCounterADart = int Function(Pointer<Void>, Pointer<Utf8>, int, Pointer<Void>);
final PdhAddCounterA = DynamicLibrary.open('pdh.dll')
    .lookupFunction<PdhAddCounterANative, PdhAddCounterADart>('PdhAddCounterA');
// hQuery : PDH_HQUERY -> Pointer<Void>
// szFullCounterPath : LPCSTR -> Pointer<Utf8>
// dwUserData : UINT_PTR -> UintPtr
// phCounter : PDH_HCOUNTER* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PdhAddCounterA(
  hQuery: THandle;   // PDH_HQUERY
  szFullCounterPath: PAnsiChar;   // LPCSTR
  dwUserData: NativeUInt;   // UINT_PTR
  phCounter: Pointer   // PDH_HCOUNTER* out
): DWORD; stdcall;
  external 'pdh.dll' name 'PdhAddCounterA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PdhAddCounterA"
  c_PdhAddCounterA :: Ptr () -> CString -> CUIntPtr -> Ptr () -> IO Word32
-- hQuery : PDH_HQUERY -> Ptr ()
-- szFullCounterPath : LPCSTR -> CString
-- dwUserData : UINT_PTR -> CUIntPtr
-- phCounter : PDH_HCOUNTER* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pdhaddcountera =
  foreign "PdhAddCounterA"
    ((ptr void) @-> string @-> size_t @-> (ptr void) @-> returning uint32_t)
(* hQuery : PDH_HQUERY -> (ptr void) *)
(* szFullCounterPath : LPCSTR -> string *)
(* dwUserData : UINT_PTR -> size_t *)
(* phCounter : PDH_HCOUNTER* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library pdh (t "pdh.dll"))
(cffi:use-foreign-library pdh)

(cffi:defcfun ("PdhAddCounterA" pdh-add-counter-a :convention :stdcall) :uint32
  (h-query :pointer)   ; PDH_HQUERY
  (sz-full-counter-path :string)   ; LPCSTR
  (dw-user-data :uint64)   ; UINT_PTR
  (ph-counter :pointer))   ; PDH_HCOUNTER* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PdhAddCounterA = Win32::API::More->new('pdh',
    'DWORD PdhAddCounterA(HANDLE hQuery, LPCSTR szFullCounterPath, WPARAM dwUserData, HANDLE phCounter)');
# my $ret = $PdhAddCounterA->Call($hQuery, $szFullCounterPath, $dwUserData, $phCounter);
# hQuery : PDH_HQUERY -> HANDLE
# szFullCounterPath : LPCSTR -> LPCSTR
# dwUserData : UINT_PTR -> WPARAM
# phCounter : PDH_HCOUNTER* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目