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

PerfEnumerateCounterSet

関数
指定マシン上のカウンターセットのGUID一覧を列挙する。
DLLADVAPI32.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

DWORD PerfEnumerateCounterSet(
    LPCWSTR szMachine,   // optional
    GUID* pCounterSetIds,   // optional
    DWORD cCounterSetIds,
    DWORD* pcCounterSetIdsActual
);

パラメーター

名前方向説明
szMachineLPCWSTRinoptionalカウンターセット識別子を取得する対象マシンの名前です。NULL の場合、関数はローカルマシンのカウンターセット識別子を取得します。
pCounterSetIdsGUID*outoptional

cCounterSetIds パラメーターで指定した数の GUID を受け取るのに十分な領域を持つバッファーへのポインターです。

cCounterSetIds が 0 の場合は NULL でもかまいません。

cCounterSetIdsDWORDinpCounterSetIds パラメーターで指定したバッファーのサイズで、GUID 単位で表します。
pcCounterSetIdsActualDWORD*out

カウンターセット識別子を取得するために実際に必要なバッファーのサイズです。意味は関数の

戻り値に依存します。

関数の戻り値 pcCounterSetIdsActual の意味
ERROR_SUCCESS pCounterSetIds で指定したバッファーに関数が格納した

GUID の数です。

ERROR_NOT_ENOUGH_MEMORY 必要なバッファーのサイズ (GUID 単位) です。バッファーを必要な

サイズに拡大して、関数を再度呼び出してください。

その他 値は未定義であり、使用しないでください。

戻り値の型: DWORD

公式ドキュメント

指定したシステムに登録されているカウンターセットのカウンターセット識別子を取得します。カウンターセット識別子はグローバル一意識別子 (GUID) です。

戻り値

戻り値 説明
ERROR_SUCCESS
関数は、すべてのカウンターセット識別子を pCounterSetIds で指定したバッファーに正常に格納しました。pcCounterSetIdsActual が指す値は、実際にバッファーに格納されたカウンターセット識別子の数を示します。
ERROR_NOT_ENOUGH_MEMORY
pCounterSetIds で指定したバッファーは、指定したシステム上のカウンターセットのすべてのカウンターセット識別子を格納するのに十分な大きさではありませんでした。pcCounterSetIdsActual が指す値は、すべてのカウンターセット識別子を格納するために必要なバッファーのサイズを示します。バッファーを必要な

サイズに拡大して、関数を再度呼び出してください。

その他の種類の失敗の場合、戻り値は システムエラーコード です。

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

各言語での呼び出し定義

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

DWORD PerfEnumerateCounterSet(
    LPCWSTR szMachine,   // optional
    GUID* pCounterSetIds,   // optional
    DWORD cCounterSetIds,
    DWORD* pcCounterSetIdsActual
);
[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint PerfEnumerateCounterSet(
    [MarshalAs(UnmanagedType.LPWStr)] string szMachine,   // LPCWSTR optional
    IntPtr pCounterSetIds,   // GUID* optional, out
    uint cCounterSetIds,   // DWORD
    out uint pcCounterSetIdsActual   // DWORD* out
);
<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function PerfEnumerateCounterSet(
    <MarshalAs(UnmanagedType.LPWStr)> szMachine As String,   ' LPCWSTR optional
    pCounterSetIds As IntPtr,   ' GUID* optional, out
    cCounterSetIds As UInteger,   ' DWORD
    <Out> ByRef pcCounterSetIdsActual As UInteger   ' DWORD* out
) As UInteger
End Function
' szMachine : LPCWSTR optional
' pCounterSetIds : GUID* optional, out
' cCounterSetIds : DWORD
' pcCounterSetIdsActual : DWORD* out
Declare PtrSafe Function PerfEnumerateCounterSet Lib "advapi32" ( _
    ByVal szMachine As LongPtr, _
    ByVal pCounterSetIds As LongPtr, _
    ByVal cCounterSetIds As Long, _
    ByRef pcCounterSetIdsActual As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PerfEnumerateCounterSet = ctypes.windll.advapi32.PerfEnumerateCounterSet
PerfEnumerateCounterSet.restype = wintypes.DWORD
PerfEnumerateCounterSet.argtypes = [
    wintypes.LPCWSTR,  # szMachine : LPCWSTR optional
    ctypes.c_void_p,  # pCounterSetIds : GUID* optional, out
    wintypes.DWORD,  # cCounterSetIds : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcCounterSetIdsActual : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
PerfEnumerateCounterSet = Fiddle::Function.new(
  lib['PerfEnumerateCounterSet'],
  [
    Fiddle::TYPE_VOIDP,  # szMachine : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # pCounterSetIds : GUID* optional, out
    -Fiddle::TYPE_INT,  # cCounterSetIds : DWORD
    Fiddle::TYPE_VOIDP,  # pcCounterSetIdsActual : DWORD* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn PerfEnumerateCounterSet(
        szMachine: *const u16,  // LPCWSTR optional
        pCounterSetIds: *mut GUID,  // GUID* optional, out
        cCounterSetIds: u32,  // DWORD
        pcCounterSetIdsActual: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint PerfEnumerateCounterSet([MarshalAs(UnmanagedType.LPWStr)] string szMachine, IntPtr pCounterSetIds, uint cCounterSetIds, out uint pcCounterSetIdsActual);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_PerfEnumerateCounterSet' -Namespace Win32 -PassThru
# $api::PerfEnumerateCounterSet(szMachine, pCounterSetIds, cCounterSetIds, pcCounterSetIdsActual)
#uselib "ADVAPI32.dll"
#func global PerfEnumerateCounterSet "PerfEnumerateCounterSet" sptr, sptr, sptr, sptr
; PerfEnumerateCounterSet szMachine, varptr(pCounterSetIds), cCounterSetIds, varptr(pcCounterSetIdsActual)   ; 戻り値は stat
; szMachine : LPCWSTR optional -> "sptr"
; pCounterSetIds : GUID* optional, out -> "sptr"
; cCounterSetIds : DWORD -> "sptr"
; pcCounterSetIdsActual : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ADVAPI32.dll"
#cfunc global PerfEnumerateCounterSet "PerfEnumerateCounterSet" wstr, var, int, var
; res = PerfEnumerateCounterSet(szMachine, pCounterSetIds, cCounterSetIds, pcCounterSetIdsActual)
; szMachine : LPCWSTR optional -> "wstr"
; pCounterSetIds : GUID* optional, out -> "var"
; cCounterSetIds : DWORD -> "int"
; pcCounterSetIdsActual : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD PerfEnumerateCounterSet(LPCWSTR szMachine, GUID* pCounterSetIds, DWORD cCounterSetIds, DWORD* pcCounterSetIdsActual)
#uselib "ADVAPI32.dll"
#cfunc global PerfEnumerateCounterSet "PerfEnumerateCounterSet" wstr, var, int, var
; res = PerfEnumerateCounterSet(szMachine, pCounterSetIds, cCounterSetIds, pcCounterSetIdsActual)
; szMachine : LPCWSTR optional -> "wstr"
; pCounterSetIds : GUID* optional, out -> "var"
; cCounterSetIds : DWORD -> "int"
; pcCounterSetIdsActual : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procPerfEnumerateCounterSet = advapi32.NewProc("PerfEnumerateCounterSet")
)

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

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

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

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

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

(cffi:defcfun ("PerfEnumerateCounterSet" perf-enumerate-counter-set :convention :stdcall) :uint32
  (sz-machine (:string :encoding :utf-16le))   ; LPCWSTR optional
  (p-counter-set-ids :pointer)   ; GUID* optional, out
  (c-counter-set-ids :uint32)   ; DWORD
  (pc-counter-set-ids-actual :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PerfEnumerateCounterSet = Win32::API::More->new('ADVAPI32',
    'DWORD PerfEnumerateCounterSet(LPCWSTR szMachine, LPVOID pCounterSetIds, DWORD cCounterSetIds, LPVOID pcCounterSetIdsActual)');
# my $ret = $PerfEnumerateCounterSet->Call($szMachine, $pCounterSetIds, $cCounterSetIds, $pcCounterSetIdsActual);
# szMachine : LPCWSTR optional -> LPCWSTR
# pCounterSetIds : GUID* optional, out -> LPVOID
# cCounterSetIds : DWORD -> DWORD
# pcCounterSetIdsActual : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目