ホーム › System.Performance › PdhAddEnglishCounterA
PdhAddEnglishCounterA
関数英語カウンター名で照会にカウンターを追加する(ANSI版)。
シグネチャ
// pdh.dll (ANSI / -A)
#include <windows.h>
DWORD PdhAddEnglishCounterA(
PDH_HQUERY hQuery,
LPCSTR szFullCounterPath,
UINT_PTR dwUserData,
PDH_HCOUNTER* phCounter
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hQuery | PDH_HQUERY | in | カウンターを追加する対象のクエリへのハンドル。このハンドルは PdhOpenQuery 関数によって返されます。 |
| szFullCounterPath | LPCSTR | in | カウンターパスを含む NULL 終端文字列。カウンターパスの形式の詳細については、 Specifying a Counter Path を参照してください。カウンターパスの最大長は PDH_MAX_COUNTER_PATH です。 |
| dwUserData | UINT_PTR | in | ユーザー定義の値。この値はカウンター情報の一部になります。後でこの値を取得するには、PdhGetCounterInfo 関数を呼び出し、PDH_COUNTER_INFO 構造体の dwQueryUserData メンバーにアクセスします。 |
| phCounter | PDH_HCOUNTER* | out | クエリに追加されたカウンターへのハンドル。後続の呼び出しでこのハンドルを参照する必要がある場合があります。 |
戻り値の型: DWORD
公式ドキュメント
指定された言語非依存のカウンターをクエリに追加します。(ANSI)
戻り値
関数が成功した場合は ERROR_SUCCESS を返します。
関数が失敗した場合、戻り値は システムエラーコード または PDH エラーコード です。次の値が取り得る値です。
| 戻り値 | 説明 |
|---|---|
| カウンターパスを解析または解釈できませんでした。 | |
| コンピューターまたはログファイル内に指定されたカウンターが見つかりませんでした。 | |
| カウンターパスが空です。 | |
| パスにコンピューター名が含まれておらず、関数がローカルコンピューター名を取得できませんでした。 | |
| コンピューターまたはログファイル内に指定されたオブジェクトが見つかりませんでした。 | |
| このカウンターに使用する計算関数を特定できませんでした。 | |
| 1 つ以上の引数が無効です。 | |
| クエリハンドルが無効です。 | |
| 関数の完了に必要なメモリを割り当てることができませんでした。 |
解説(Remarks)
この関数は、パフォーマンスカウンターをクエリに追加するための言語非依存の方法を提供します。対照的に、PdhAddCounter 関数で指定するカウンターパスはローカライズされている必要があります。
まだ存在しないカウンターインスタンスが指定された場合でも、 PdhAddEnglishCounter はエラー状態を報告しません。代わりに ERROR_SUCCESS を返します。この動作の理由は、存在しないカウンターインスタンスが指定されたのか、あるいは将来存在するがまだ作成されていないインスタンスなのかを判別できないためです。
クエリからカウンターを削除するには、 PdhRemoveCounter 関数を使用します。
注意 カウンターパスにワイルドカード文字が含まれている場合、パスのワイルドカード以外の部分はローカライズされますが、ローカライズされたカウンターパスをクエリに追加する前にワイルドカードは展開されません。この場合、一致するすべてのカウンター名をクエリに追加するには、次の手順を使用する必要があります。
- クエリを作成します
- ワイルドカードを含む文字列を指定して PdhAddEnglishCounter を使用します
- PdhAddEnglishCounter によって返されたカウンターハンドルに対して PdhGetCounterInfo を使用し、ローカライズされたフルパス(szFullPath)を取得します。この文字列にはまだワイルドカードが含まれていますが、ワイルドカード以外の部分はローカライズされています。
- PdhExpandWildCardPath を使用してワイルドカードを展開します。
- 得られた各パスに対して 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)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// pdh.dll (ANSI / -A)
#include <windows.h>
DWORD PdhAddEnglishCounterA(
PDH_HQUERY hQuery,
LPCSTR szFullCounterPath,
UINT_PTR dwUserData,
PDH_HCOUNTER* phCounter
);[DllImport("pdh.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint PdhAddEnglishCounterA(
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 PdhAddEnglishCounterA(
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 PdhAddEnglishCounterA 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
PdhAddEnglishCounterA = ctypes.windll.pdh.PdhAddEnglishCounterA
PdhAddEnglishCounterA.restype = wintypes.DWORD
PdhAddEnglishCounterA.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')
PdhAddEnglishCounterA = Fiddle::Function.new(
lib['PdhAddEnglishCounterA'],
[
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 PdhAddEnglishCounterA(
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 PdhAddEnglishCounterA(IntPtr hQuery, [MarshalAs(UnmanagedType.LPStr)] string szFullCounterPath, UIntPtr dwUserData, IntPtr phCounter);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhAddEnglishCounterA' -Namespace Win32 -PassThru
# $api::PdhAddEnglishCounterA(hQuery, szFullCounterPath, dwUserData, phCounter)#uselib "pdh.dll"
#func global PdhAddEnglishCounterA "PdhAddEnglishCounterA" sptr, sptr, sptr, sptr
; PdhAddEnglishCounterA 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 PdhAddEnglishCounterA "PdhAddEnglishCounterA" sptr, str, sptr, sptr
; res = PdhAddEnglishCounterA(hQuery, szFullCounterPath, dwUserData, phCounter)
; hQuery : PDH_HQUERY -> "sptr"
; szFullCounterPath : LPCSTR -> "str"
; dwUserData : UINT_PTR -> "sptr"
; phCounter : PDH_HCOUNTER* out -> "sptr"; DWORD PdhAddEnglishCounterA(PDH_HQUERY hQuery, LPCSTR szFullCounterPath, UINT_PTR dwUserData, PDH_HCOUNTER* phCounter)
#uselib "pdh.dll"
#cfunc global PdhAddEnglishCounterA "PdhAddEnglishCounterA" intptr, str, intptr, intptr
; res = PdhAddEnglishCounterA(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")
procPdhAddEnglishCounterA = pdh.NewProc("PdhAddEnglishCounterA")
)
// hQuery (PDH_HQUERY), szFullCounterPath (LPCSTR), dwUserData (UINT_PTR), phCounter (PDH_HCOUNTER* out)
r1, _, err := procPdhAddEnglishCounterA.Call(
uintptr(hQuery),
uintptr(unsafe.Pointer(windows.BytePtrFromString(szFullCounterPath))),
uintptr(dwUserData),
uintptr(phCounter),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction PdhAddEnglishCounterA(
hQuery: THandle; // PDH_HQUERY
szFullCounterPath: PAnsiChar; // LPCSTR
dwUserData: NativeUInt; // UINT_PTR
phCounter: Pointer // PDH_HCOUNTER* out
): DWORD; stdcall;
external 'pdh.dll' name 'PdhAddEnglishCounterA';result := DllCall("pdh\PdhAddEnglishCounterA"
, "Ptr", hQuery ; PDH_HQUERY
, "AStr", szFullCounterPath ; LPCSTR
, "UPtr", dwUserData ; UINT_PTR
, "Ptr", phCounter ; PDH_HCOUNTER* out
, "UInt") ; return: DWORD●PdhAddEnglishCounterA(hQuery, szFullCounterPath, dwUserData, phCounter) = DLL("pdh.dll", "dword PdhAddEnglishCounterA(void*, char*, int, void*)")
# 呼び出し: PdhAddEnglishCounterA(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 PdhAddEnglishCounterA(
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 PdhAddEnglishCounterA(
hQuery: pointer, # PDH_HQUERY
szFullCounterPath: cstring, # LPCSTR
dwUserData: uint, # UINT_PTR
phCounter: pointer # PDH_HCOUNTER* out
): uint32 {.importc: "PdhAddEnglishCounterA", stdcall, dynlib: "pdh.dll".}pragma(lib, "pdh");
extern(Windows)
uint PdhAddEnglishCounterA(
void* hQuery, // PDH_HQUERY
const(char)* szFullCounterPath, // LPCSTR
size_t dwUserData, // UINT_PTR
void* phCounter // PDH_HCOUNTER* out
);ccall((:PdhAddEnglishCounterA, "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 PdhAddEnglishCounterA(
void* hQuery,
const char* szFullCounterPath,
uintptr_t dwUserData,
void* phCounter);
]]
local pdh = ffi.load("pdh")
-- pdh.PdhAddEnglishCounterA(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 PdhAddEnglishCounterA = lib.func('__stdcall', 'PdhAddEnglishCounterA', 'uint32_t', ['void *', 'str', 'uintptr_t', 'void *']);
// PdhAddEnglishCounterA(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", {
PdhAddEnglishCounterA: { parameters: ["pointer", "buffer", "usize", "pointer"], result: "u32" },
});
// lib.symbols.PdhAddEnglishCounterA(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 PdhAddEnglishCounterA(
void* hQuery,
const char* szFullCounterPath,
size_t dwUserData,
void* phCounter);
C, "pdh.dll");
// $ffi->PdhAddEnglishCounterA(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 PdhAddEnglishCounterA(
Pointer hQuery, // PDH_HQUERY
String szFullCounterPath, // LPCSTR
long dwUserData, // UINT_PTR
Pointer phCounter // PDH_HCOUNTER* out
);
}@[Link("pdh")]
lib Libpdh
fun PdhAddEnglishCounterA = PdhAddEnglishCounterA(
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 PdhAddEnglishCounterANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, UintPtr, Pointer<Void>);
typedef PdhAddEnglishCounterADart = int Function(Pointer<Void>, Pointer<Utf8>, int, Pointer<Void>);
final PdhAddEnglishCounterA = DynamicLibrary.open('pdh.dll')
.lookupFunction<PdhAddEnglishCounterANative, PdhAddEnglishCounterADart>('PdhAddEnglishCounterA');
// 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 PdhAddEnglishCounterA(
hQuery: THandle; // PDH_HQUERY
szFullCounterPath: PAnsiChar; // LPCSTR
dwUserData: NativeUInt; // UINT_PTR
phCounter: Pointer // PDH_HCOUNTER* out
): DWORD; stdcall;
external 'pdh.dll' name 'PdhAddEnglishCounterA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "PdhAddEnglishCounterA"
c_PdhAddEnglishCounterA :: 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 pdhaddenglishcountera =
foreign "PdhAddEnglishCounterA"
((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 ("PdhAddEnglishCounterA" pdh-add-english-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 $PdhAddEnglishCounterA = Win32::API::More->new('pdh',
'DWORD PdhAddEnglishCounterA(HANDLE hQuery, LPCSTR szFullCounterPath, WPARAM dwUserData, HANDLE phCounter)');
# my $ret = $PdhAddEnglishCounterA->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 を使用。関連項目
文字セット違い
- f PdhAddEnglishCounterW (Unicode版) — 言語非依存の英語カウンター名で照会にカウンターを追加する。
公式の関連項目
- f PdhAddCounterA — 照会にカウンターパスを指定して追加する(ANSI版)。
- f PdhBrowseCountersA — カウンター選択ダイアログを表示する(ANSI版)。
- f PdhMakeCounterPathA — 構成要素からカウンターパス文字列を生成する(ANSI版)。
- f PdhOpenQueryA — 新しいパフォーマンスデータ照会を作成して開く(ANSI版)。
- f PdhRemoveCounter — 照会からカウンターを削除する。