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

PdhOpenQueryA

関数
新しいパフォーマンスデータ照会を作成して開く(ANSI版)。
DLLpdh.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD PdhOpenQueryA(
    LPCSTR szDataSource,   // optional
    UINT_PTR dwUserData,
    PDH_HQUERY* phQuery
);

パラメーター

名前方向説明
szDataSourceLPCSTRinoptionalパフォーマンスデータを取得するログファイルの名前を指定する Null 終端文字列です。NULL の場合、パフォーマンスデータはリアルタイムのデータソースから収集されます。
dwUserDataUINT_PTRinこのクエリに関連付けるユーザー定義の値です。後でユーザーデータを取得するには、 PdhGetCounterInfo を呼び出し、PDH_COUNTER_INFOdwQueryUserData メンバーにアクセスしてください。
phQueryPDH_HQUERY*outクエリへのハンドルです。このハンドルは後続の呼び出しで使用します。

戻り値の型: DWORD

公式ドキュメント

パフォーマンスデータの収集を管理するために使用される新しいクエリを作成します。データソースへのハンドルを使用するには、PdhOpenQueryH 関数を使用してください。(ANSI)

戻り値

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

関数が失敗した場合、戻り値は システムエラーコード または PDH エラーコード です。

解説(Remarks)

メモ

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

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

PdhOpenQueryA = ctypes.windll.pdh.PdhOpenQueryA
PdhOpenQueryA.restype = wintypes.DWORD
PdhOpenQueryA.argtypes = [
    wintypes.LPCSTR,  # szDataSource : LPCSTR optional
    ctypes.c_size_t,  # dwUserData : UINT_PTR
    ctypes.c_void_p,  # phQuery : PDH_HQUERY* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	pdh = windows.NewLazySystemDLL("pdh.dll")
	procPdhOpenQueryA = pdh.NewProc("PdhOpenQueryA")
)

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

extern "pdh" fn PdhOpenQueryA(
    szDataSource: [*c]const u8, // LPCSTR optional
    dwUserData: usize, // UINT_PTR
    phQuery: ?*anyopaque // PDH_HQUERY* out
) callconv(std.os.windows.WINAPI) u32;
proc PdhOpenQueryA(
    szDataSource: cstring,  # LPCSTR optional
    dwUserData: uint,  # UINT_PTR
    phQuery: pointer  # PDH_HQUERY* out
): uint32 {.importc: "PdhOpenQueryA", stdcall, dynlib: "pdh.dll".}
pragma(lib, "pdh");
extern(Windows)
uint PdhOpenQueryA(
    const(char)* szDataSource,   // LPCSTR optional
    size_t dwUserData,   // UINT_PTR
    void* phQuery   // PDH_HQUERY* out
);
ccall((:PdhOpenQueryA, "pdh.dll"), stdcall, UInt32,
      (Cstring, Csize_t, Ptr{Cvoid}),
      szDataSource, dwUserData, phQuery)
# szDataSource : LPCSTR optional -> Cstring
# dwUserData : UINT_PTR -> Csize_t
# phQuery : PDH_HQUERY* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t PdhOpenQueryA(
    const char* szDataSource,
    uintptr_t dwUserData,
    void* phQuery);
]]
local pdh = ffi.load("pdh")
-- pdh.PdhOpenQueryA(szDataSource, dwUserData, phQuery)
-- szDataSource : LPCSTR optional
-- dwUserData : UINT_PTR
-- phQuery : PDH_HQUERY* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('pdh.dll');
const PdhOpenQueryA = lib.func('__stdcall', 'PdhOpenQueryA', 'uint32_t', ['str', 'uintptr_t', 'void *']);
// PdhOpenQueryA(szDataSource, dwUserData, phQuery)
// szDataSource : LPCSTR optional -> 'str'
// dwUserData : UINT_PTR -> 'uintptr_t'
// phQuery : PDH_HQUERY* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("pdh.dll", {
  PdhOpenQueryA: { parameters: ["buffer", "usize", "pointer"], result: "u32" },
});
// lib.symbols.PdhOpenQueryA(szDataSource, dwUserData, phQuery)
// szDataSource : LPCSTR optional -> "buffer"
// dwUserData : UINT_PTR -> "usize"
// phQuery : PDH_HQUERY* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t PdhOpenQueryA(
    const char* szDataSource,
    size_t dwUserData,
    void* phQuery);
C, "pdh.dll");
// $ffi->PdhOpenQueryA(szDataSource, dwUserData, phQuery);
// szDataSource : LPCSTR optional
// dwUserData : UINT_PTR
// phQuery : PDH_HQUERY* 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 PdhOpenQueryA(
        String szDataSource,   // LPCSTR optional
        long dwUserData,   // UINT_PTR
        Pointer phQuery   // PDH_HQUERY* out
    );
}
@[Link("pdh")]
lib Libpdh
  fun PdhOpenQueryA = PdhOpenQueryA(
    szDataSource : UInt8*,   # LPCSTR optional
    dwUserData : LibC::SizeT,   # UINT_PTR
    phQuery : Void*   # PDH_HQUERY* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

let pdhopenquerya =
  foreign "PdhOpenQueryA"
    (string @-> size_t @-> (ptr void) @-> returning uint32_t)
(* szDataSource : LPCSTR optional -> string *)
(* dwUserData : UINT_PTR -> size_t *)
(* phQuery : PDH_HQUERY* 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 ("PdhOpenQueryA" pdh-open-query-a :convention :stdcall) :uint32
  (sz-data-source :string)   ; LPCSTR optional
  (dw-user-data :uint64)   ; UINT_PTR
  (ph-query :pointer))   ; PDH_HQUERY* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PdhOpenQueryA = Win32::API::More->new('pdh',
    'DWORD PdhOpenQueryA(LPCSTR szDataSource, WPARAM dwUserData, HANDLE phQuery)');
# my $ret = $PdhOpenQueryA->Call($szDataSource, $dwUserData, $phQuery);
# szDataSource : LPCSTR optional -> LPCSTR
# dwUserData : UINT_PTR -> WPARAM
# phQuery : PDH_HQUERY* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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