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

PerfOpenQueryHandle

関数
パフォーマンスデータ照会用のハンドルを開く。
DLLADVAPI32.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

// ADVAPI32.dll
#include <windows.h>

DWORD PerfOpenQueryHandle(
    LPCWSTR szMachine,   // optional
    HANDLE* phQuery
);

パラメーター

名前方向説明
szMachineLPCWSTRinoptionalクエリハンドルを取得する対象のマシン名。
phQueryHANDLE*outクエリのハンドル。このハンドルが不要になったら、PerfCloseQueryHandle を呼び出して閉じてください。

戻り値の型: DWORD

公式ドキュメント

指定したシステム上のクエリを参照するハンドルを作成します。クエリは、カウンター指定のリストです。

戻り値

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

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

解説(Remarks)

リストへのカウンター指定の追加または削除には、PerfAddCountersPerfDeleteCounters を使用します。現在リストに含まれているカウンター指定を取得し、各カウンターのデータが PerfQueryCounterData によって返されるインデックスを確認するには、PerfQueryCounterInfo を使用します。カウンター指定に一致するカウンターの値を取得するには、PerfQueryCounterData を使用します。

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

各言語での呼び出し定義

// ADVAPI32.dll
#include <windows.h>

DWORD PerfOpenQueryHandle(
    LPCWSTR szMachine,   // optional
    HANDLE* phQuery
);
[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint PerfOpenQueryHandle(
    [MarshalAs(UnmanagedType.LPWStr)] string szMachine,   // LPCWSTR optional
    IntPtr phQuery   // HANDLE* out
);
<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function PerfOpenQueryHandle(
    <MarshalAs(UnmanagedType.LPWStr)> szMachine As String,   ' LPCWSTR optional
    phQuery As IntPtr   ' HANDLE* out
) As UInteger
End Function
' szMachine : LPCWSTR optional
' phQuery : HANDLE* out
Declare PtrSafe Function PerfOpenQueryHandle Lib "advapi32" ( _
    ByVal szMachine 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

PerfOpenQueryHandle = ctypes.windll.advapi32.PerfOpenQueryHandle
PerfOpenQueryHandle.restype = wintypes.DWORD
PerfOpenQueryHandle.argtypes = [
    wintypes.LPCWSTR,  # szMachine : LPCWSTR optional
    ctypes.c_void_p,  # phQuery : HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procPerfOpenQueryHandle = advapi32.NewProc("PerfOpenQueryHandle")
)

// szMachine (LPCWSTR optional), phQuery (HANDLE* out)
r1, _, err := procPerfOpenQueryHandle.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szMachine))),
	uintptr(phQuery),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function PerfOpenQueryHandle(
  szMachine: PWideChar;   // LPCWSTR optional
  phQuery: Pointer   // HANDLE* out
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'PerfOpenQueryHandle';
result := DllCall("ADVAPI32\PerfOpenQueryHandle"
    , "WStr", szMachine   ; LPCWSTR optional
    , "Ptr", phQuery   ; HANDLE* out
    , "UInt")   ; return: DWORD
●PerfOpenQueryHandle(szMachine, phQuery) = DLL("ADVAPI32.dll", "dword PerfOpenQueryHandle(char*, void*)")
# 呼び出し: PerfOpenQueryHandle(szMachine, phQuery)
# szMachine : LPCWSTR optional -> "char*"
# phQuery : HANDLE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn PerfOpenQueryHandle(
    szMachine: [*c]const u16, // LPCWSTR optional
    phQuery: ?*anyopaque // HANDLE* out
) callconv(std.os.windows.WINAPI) u32;
proc PerfOpenQueryHandle(
    szMachine: WideCString,  # LPCWSTR optional
    phQuery: pointer  # HANDLE* out
): uint32 {.importc: "PerfOpenQueryHandle", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
uint PerfOpenQueryHandle(
    const(wchar)* szMachine,   // LPCWSTR optional
    void* phQuery   // HANDLE* out
);
ccall((:PerfOpenQueryHandle, "ADVAPI32.dll"), stdcall, UInt32,
      (Cwstring, Ptr{Cvoid}),
      szMachine, phQuery)
# szMachine : LPCWSTR optional -> Cwstring
# phQuery : HANDLE* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t PerfOpenQueryHandle(
    const uint16_t* szMachine,
    void* phQuery);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.PerfOpenQueryHandle(szMachine, phQuery)
-- szMachine : LPCWSTR optional
-- phQuery : HANDLE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const PerfOpenQueryHandle = lib.func('__stdcall', 'PerfOpenQueryHandle', 'uint32_t', ['str16', 'void *']);
// PerfOpenQueryHandle(szMachine, phQuery)
// szMachine : LPCWSTR optional -> 'str16'
// phQuery : HANDLE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  PerfOpenQueryHandle: { parameters: ["buffer", "pointer"], result: "u32" },
});
// lib.symbols.PerfOpenQueryHandle(szMachine, phQuery)
// szMachine : LPCWSTR optional -> "buffer"
// phQuery : HANDLE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t PerfOpenQueryHandle(
    const uint16_t* szMachine,
    void* phQuery);
C, "ADVAPI32.dll");
// $ffi->PerfOpenQueryHandle(szMachine, phQuery);
// szMachine : LPCWSTR optional
// phQuery : HANDLE* 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 Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class);
    int PerfOpenQueryHandle(
        WString szMachine,   // LPCWSTR optional
        Pointer phQuery   // HANDLE* out
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun PerfOpenQueryHandle = PerfOpenQueryHandle(
    szMachine : UInt16*,   # LPCWSTR optional
    phQuery : Void*   # HANDLE* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PerfOpenQueryHandleNative = Uint32 Function(Pointer<Utf16>, Pointer<Void>);
typedef PerfOpenQueryHandleDart = int Function(Pointer<Utf16>, Pointer<Void>);
final PerfOpenQueryHandle = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<PerfOpenQueryHandleNative, PerfOpenQueryHandleDart>('PerfOpenQueryHandle');
// szMachine : LPCWSTR optional -> Pointer<Utf16>
// phQuery : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PerfOpenQueryHandle(
  szMachine: PWideChar;   // LPCWSTR optional
  phQuery: Pointer   // HANDLE* out
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'PerfOpenQueryHandle';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PerfOpenQueryHandle"
  c_PerfOpenQueryHandle :: CWString -> Ptr () -> IO Word32
-- szMachine : LPCWSTR optional -> CWString
-- phQuery : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let perfopenqueryhandle =
  foreign "PerfOpenQueryHandle"
    ((ptr uint16_t) @-> (ptr void) @-> returning uint32_t)
(* szMachine : LPCWSTR optional -> (ptr uint16_t) *)
(* phQuery : HANDLE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("PerfOpenQueryHandle" perf-open-query-handle :convention :stdcall) :uint32
  (sz-machine (:string :encoding :utf-16le))   ; LPCWSTR optional
  (ph-query :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PerfOpenQueryHandle = Win32::API::More->new('ADVAPI32',
    'DWORD PerfOpenQueryHandle(LPCWSTR szMachine, HANDLE phQuery)');
# my $ret = $PerfOpenQueryHandle->Call($szMachine, $phQuery);
# szMachine : LPCWSTR optional -> LPCWSTR
# phQuery : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目