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

PdhAddEnglishCounterW

関数
言語非依存の英語カウンター名で照会にカウンターを追加する。
DLLpdh.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// pdh.dll  (Unicode / -W)
#include <windows.h>

DWORD PdhAddEnglishCounterW(
    PDH_HQUERY hQuery,
    LPCWSTR szFullCounterPath,
    UINT_PTR dwUserData,
    PDH_HCOUNTER* phCounter
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

指定された言語非依存のカウンターをクエリに追加します。(Unicode)

戻り値

関数が成功した場合は 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 関数で指定するカウンターパスはローカライズされている必要があります。

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

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

Note カウンターパスにワイルドカード文字が含まれている場合、パスのワイルドカード以外の部分はローカライズされますが、ローカライズされたカウンターパスをクエリに追加する前にワイルドカードが展開されることはありません。この場合、一致するすべてのカウンター名をクエリに追加するには、次の手順を使用する必要があります。
  1. クエリを作成します
  2. ワイルドカードを含む文字列を指定して PdhAddEnglishCounter を使用します
  3. PdhAddEnglishCounter によって返されたカウンターハンドルに対して PdhGetCounterInfo を使用して、ローカライズされたフルパス(szFullPath)を取得します。この文字列にはまだワイルドカードが含まれていますが、ワイルドカード以外の部分はローカライズされています。
  4. PdhExpandWildCardPath を使用してワイルドカードを展開します。
  5. 結果として得られた各パスに対して PdhAddCounter を使用します
メモ

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

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

各言語での呼び出し定義

// pdh.dll  (Unicode / -W)
#include <windows.h>

DWORD PdhAddEnglishCounterW(
    PDH_HQUERY hQuery,
    LPCWSTR szFullCounterPath,
    UINT_PTR dwUserData,
    PDH_HCOUNTER* phCounter
);
[DllImport("pdh.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PdhAddEnglishCounterW(
    IntPtr hQuery,   // PDH_HQUERY
    [MarshalAs(UnmanagedType.LPWStr)] string szFullCounterPath,   // LPCWSTR
    UIntPtr dwUserData,   // UINT_PTR
    IntPtr phCounter   // PDH_HCOUNTER* out
);
<DllImport("pdh.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PdhAddEnglishCounterW(
    hQuery As IntPtr,   ' PDH_HQUERY
    <MarshalAs(UnmanagedType.LPWStr)> szFullCounterPath As String,   ' LPCWSTR
    dwUserData As UIntPtr,   ' UINT_PTR
    phCounter As IntPtr   ' PDH_HCOUNTER* out
) As UInteger
End Function
' hQuery : PDH_HQUERY
' szFullCounterPath : LPCWSTR
' dwUserData : UINT_PTR
' phCounter : PDH_HCOUNTER* out
Declare PtrSafe Function PdhAddEnglishCounterW Lib "pdh" ( _
    ByVal hQuery As LongPtr, _
    ByVal szFullCounterPath As LongPtr, _
    ByVal dwUserData As LongPtr, _
    ByVal phCounter As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PdhAddEnglishCounterW = ctypes.windll.pdh.PdhAddEnglishCounterW
PdhAddEnglishCounterW.restype = wintypes.DWORD
PdhAddEnglishCounterW.argtypes = [
    wintypes.HANDLE,  # hQuery : PDH_HQUERY
    wintypes.LPCWSTR,  # szFullCounterPath : LPCWSTR
    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')
PdhAddEnglishCounterW = Fiddle::Function.new(
  lib['PdhAddEnglishCounterW'],
  [
    Fiddle::TYPE_VOIDP,  # hQuery : PDH_HQUERY
    Fiddle::TYPE_VOIDP,  # szFullCounterPath : LPCWSTR
    Fiddle::TYPE_UINTPTR_T,  # dwUserData : UINT_PTR
    Fiddle::TYPE_VOIDP,  # phCounter : PDH_HCOUNTER* out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "pdh")]
extern "system" {
    fn PdhAddEnglishCounterW(
        hQuery: *mut core::ffi::c_void,  // PDH_HQUERY
        szFullCounterPath: *const u16,  // LPCWSTR
        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.Unicode)]
public static extern uint PdhAddEnglishCounterW(IntPtr hQuery, [MarshalAs(UnmanagedType.LPWStr)] string szFullCounterPath, UIntPtr dwUserData, IntPtr phCounter);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhAddEnglishCounterW' -Namespace Win32 -PassThru
# $api::PdhAddEnglishCounterW(hQuery, szFullCounterPath, dwUserData, phCounter)
#uselib "pdh.dll"
#func global PdhAddEnglishCounterW "PdhAddEnglishCounterW" wptr, wptr, wptr, wptr
; PdhAddEnglishCounterW hQuery, szFullCounterPath, dwUserData, phCounter   ; 戻り値は stat
; hQuery : PDH_HQUERY -> "wptr"
; szFullCounterPath : LPCWSTR -> "wptr"
; dwUserData : UINT_PTR -> "wptr"
; phCounter : PDH_HCOUNTER* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "pdh.dll"
#cfunc global PdhAddEnglishCounterW "PdhAddEnglishCounterW" sptr, wstr, sptr, sptr
; res = PdhAddEnglishCounterW(hQuery, szFullCounterPath, dwUserData, phCounter)
; hQuery : PDH_HQUERY -> "sptr"
; szFullCounterPath : LPCWSTR -> "wstr"
; dwUserData : UINT_PTR -> "sptr"
; phCounter : PDH_HCOUNTER* out -> "sptr"
; DWORD PdhAddEnglishCounterW(PDH_HQUERY hQuery, LPCWSTR szFullCounterPath, UINT_PTR dwUserData, PDH_HCOUNTER* phCounter)
#uselib "pdh.dll"
#cfunc global PdhAddEnglishCounterW "PdhAddEnglishCounterW" intptr, wstr, intptr, intptr
; res = PdhAddEnglishCounterW(hQuery, szFullCounterPath, dwUserData, phCounter)
; hQuery : PDH_HQUERY -> "intptr"
; szFullCounterPath : LPCWSTR -> "wstr"
; dwUserData : UINT_PTR -> "intptr"
; phCounter : PDH_HCOUNTER* out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	pdh = windows.NewLazySystemDLL("pdh.dll")
	procPdhAddEnglishCounterW = pdh.NewProc("PdhAddEnglishCounterW")
)

// hQuery (PDH_HQUERY), szFullCounterPath (LPCWSTR), dwUserData (UINT_PTR), phCounter (PDH_HCOUNTER* out)
r1, _, err := procPdhAddEnglishCounterW.Call(
	uintptr(hQuery),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szFullCounterPath))),
	uintptr(dwUserData),
	uintptr(phCounter),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function PdhAddEnglishCounterW(
  hQuery: THandle;   // PDH_HQUERY
  szFullCounterPath: PWideChar;   // LPCWSTR
  dwUserData: NativeUInt;   // UINT_PTR
  phCounter: Pointer   // PDH_HCOUNTER* out
): DWORD; stdcall;
  external 'pdh.dll' name 'PdhAddEnglishCounterW';
result := DllCall("pdh\PdhAddEnglishCounterW"
    , "Ptr", hQuery   ; PDH_HQUERY
    , "WStr", szFullCounterPath   ; LPCWSTR
    , "UPtr", dwUserData   ; UINT_PTR
    , "Ptr", phCounter   ; PDH_HCOUNTER* out
    , "UInt")   ; return: DWORD
●PdhAddEnglishCounterW(hQuery, szFullCounterPath, dwUserData, phCounter) = DLL("pdh.dll", "dword PdhAddEnglishCounterW(void*, char*, int, void*)")
# 呼び出し: PdhAddEnglishCounterW(hQuery, szFullCounterPath, dwUserData, phCounter)
# hQuery : PDH_HQUERY -> "void*"
# szFullCounterPath : LPCWSTR -> "char*"
# dwUserData : UINT_PTR -> "int"
# phCounter : PDH_HCOUNTER* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "pdh" fn PdhAddEnglishCounterW(
    hQuery: ?*anyopaque, // PDH_HQUERY
    szFullCounterPath: [*c]const u16, // LPCWSTR
    dwUserData: usize, // UINT_PTR
    phCounter: ?*anyopaque // PDH_HCOUNTER* out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc PdhAddEnglishCounterW(
    hQuery: pointer,  # PDH_HQUERY
    szFullCounterPath: WideCString,  # LPCWSTR
    dwUserData: uint,  # UINT_PTR
    phCounter: pointer  # PDH_HCOUNTER* out
): uint32 {.importc: "PdhAddEnglishCounterW", stdcall, dynlib: "pdh.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "pdh");
extern(Windows)
uint PdhAddEnglishCounterW(
    void* hQuery,   // PDH_HQUERY
    const(wchar)* szFullCounterPath,   // LPCWSTR
    size_t dwUserData,   // UINT_PTR
    void* phCounter   // PDH_HCOUNTER* out
);
ccall((:PdhAddEnglishCounterW, "pdh.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cwstring, Csize_t, Ptr{Cvoid}),
      hQuery, szFullCounterPath, dwUserData, phCounter)
# hQuery : PDH_HQUERY -> Ptr{Cvoid}
# szFullCounterPath : LPCWSTR -> Cwstring
# dwUserData : UINT_PTR -> Csize_t
# phCounter : PDH_HCOUNTER* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t PdhAddEnglishCounterW(
    void* hQuery,
    const uint16_t* szFullCounterPath,
    uintptr_t dwUserData,
    void* phCounter);
]]
local pdh = ffi.load("pdh")
-- pdh.PdhAddEnglishCounterW(hQuery, szFullCounterPath, dwUserData, phCounter)
-- hQuery : PDH_HQUERY
-- szFullCounterPath : LPCWSTR
-- dwUserData : UINT_PTR
-- phCounter : PDH_HCOUNTER* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('pdh.dll');
const PdhAddEnglishCounterW = lib.func('__stdcall', 'PdhAddEnglishCounterW', 'uint32_t', ['void *', 'str16', 'uintptr_t', 'void *']);
// PdhAddEnglishCounterW(hQuery, szFullCounterPath, dwUserData, phCounter)
// hQuery : PDH_HQUERY -> 'void *'
// szFullCounterPath : LPCWSTR -> 'str16'
// dwUserData : UINT_PTR -> 'uintptr_t'
// phCounter : PDH_HCOUNTER* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("pdh.dll", {
  PdhAddEnglishCounterW: { parameters: ["pointer", "buffer", "usize", "pointer"], result: "u32" },
});
// lib.symbols.PdhAddEnglishCounterW(hQuery, szFullCounterPath, dwUserData, phCounter)
// hQuery : PDH_HQUERY -> "pointer"
// szFullCounterPath : LPCWSTR -> "buffer"
// dwUserData : UINT_PTR -> "usize"
// phCounter : PDH_HCOUNTER* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t PdhAddEnglishCounterW(
    void* hQuery,
    const uint16_t* szFullCounterPath,
    size_t dwUserData,
    void* phCounter);
C, "pdh.dll");
// $ffi->PdhAddEnglishCounterW(hQuery, szFullCounterPath, dwUserData, phCounter);
// hQuery : PDH_HQUERY
// szFullCounterPath : LPCWSTR
// 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.UNICODE_OPTIONS);
    int PdhAddEnglishCounterW(
        Pointer hQuery,   // PDH_HQUERY
        WString szFullCounterPath,   // LPCWSTR
        long dwUserData,   // UINT_PTR
        Pointer phCounter   // PDH_HCOUNTER* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("pdh")]
lib Libpdh
  fun PdhAddEnglishCounterW = PdhAddEnglishCounterW(
    hQuery : Void*,   # PDH_HQUERY
    szFullCounterPath : UInt16*,   # LPCWSTR
    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 PdhAddEnglishCounterWNative = Uint32 Function(Pointer<Void>, Pointer<Utf16>, UintPtr, Pointer<Void>);
typedef PdhAddEnglishCounterWDart = int Function(Pointer<Void>, Pointer<Utf16>, int, Pointer<Void>);
final PdhAddEnglishCounterW = DynamicLibrary.open('pdh.dll')
    .lookupFunction<PdhAddEnglishCounterWNative, PdhAddEnglishCounterWDart>('PdhAddEnglishCounterW');
// hQuery : PDH_HQUERY -> Pointer<Void>
// szFullCounterPath : LPCWSTR -> Pointer<Utf16>
// dwUserData : UINT_PTR -> UintPtr
// phCounter : PDH_HCOUNTER* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PdhAddEnglishCounterW(
  hQuery: THandle;   // PDH_HQUERY
  szFullCounterPath: PWideChar;   // LPCWSTR
  dwUserData: NativeUInt;   // UINT_PTR
  phCounter: Pointer   // PDH_HCOUNTER* out
): DWORD; stdcall;
  external 'pdh.dll' name 'PdhAddEnglishCounterW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let pdhaddenglishcounterw =
  foreign "PdhAddEnglishCounterW"
    ((ptr void) @-> (ptr uint16_t) @-> size_t @-> (ptr void) @-> returning uint32_t)
(* hQuery : PDH_HQUERY -> (ptr void) *)
(* szFullCounterPath : LPCWSTR -> (ptr uint16_t) *)
(* 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 ("PdhAddEnglishCounterW" pdh-add-english-counter-w :convention :stdcall) :uint32
  (h-query :pointer)   ; PDH_HQUERY
  (sz-full-counter-path (:string :encoding :utf-16le))   ; LPCWSTR
  (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 $PdhAddEnglishCounterW = Win32::API::More->new('pdh',
    'DWORD PdhAddEnglishCounterW(HANDLE hQuery, LPCWSTR szFullCounterPath, WPARAM dwUserData, HANDLE phCounter)');
# my $ret = $PdhAddEnglishCounterW->Call($hQuery, $szFullCounterPath, $dwUserData, $phCounter);
# hQuery : PDH_HQUERY -> HANDLE
# szFullCounterPath : LPCWSTR -> LPCWSTR
# dwUserData : UINT_PTR -> WPARAM
# phCounter : PDH_HCOUNTER* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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