ホーム › System.Performance › PerfQueryCounterSetRegistrationInfo

PerfQueryCounterSetRegistrationInfo

関数

カウンターセットの登録情報を照会して取得する。

DLLADVAPI32.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

DWORD PerfQueryCounterSetRegistrationInfo(
    LPCWSTR szMachine,   // optional
    const GUID* pCounterSetId,
    PerfRegInfoType requestCode,
    DWORD requestLangId,
    BYTE* pbRegInfo,   // optional
    DWORD cbRegInfo,
    DWORD* pcbRegInfoActual
);

パラメーター

名前

型

方向

説明

szMachine

LPCWSTR

inoptional

pCounterSet パラメーターで指定したカウンターセットに関する情報を取得する対象のマシン名。NULL の場合、この関数はローカルマシン上の指定したカウンターセットに関する情報を取得します。

pCounterSetId

GUID*

情報を取得する対象のカウンターセットのカウンターセット識別子。

requestCode

PerfRegInfoType

カウンターセットについて取得したい情報の種類。指定可能な値の一覧については、PerfRegInfoType を参照してください。

requestLangId

DWORD

requestCode が PERF_REG_COUNTERSET_NAME_STRING、

PERF_REG_COUNTERSET_HELP_STRING、PERF_REG_COUNTER_NAME_STRINGS、または

PERF_REG_COUNTER_HELP_STRINGS の場合、要求した情報を含む文字列に対して優先するロケール識別子。

requestCode が PERF_REG_COUNTER_STRUCT の場合は、データを取得する対象のカウンターのカウンター識別子。

requestCode がその他の値の場合は 0 を設定します。

pbRegInfo

BYTE*

outoptional

cbRegInfo パラメーターで指定したバイト数のデータを受け取るのに十分な大きさのバッファーへのポインター。cbRegInfo が 0 の場合は

NULL でもかまいません。

cbRegInfo

DWORD

pbRegInfo パラメーターで指定したバッファーのサイズ(バイト単位)。

pcbRegInfoActual

DWORD*

out

カウンターセットに関する情報を取得するために実際に必要なバッファーのサイズ。意味は関数が返す値によって異なります。

関数の戻り値	pcbRegInfoActual の意味
ERROR_SUCCESS	関数が pbRegInfo で指定したバッファーに格納した、指定したカウンターセットに関する情報のバイト数。
ERROR_NOT_ENOUGH_MEMORY	指定したマシン上のカウンターセットに関する情報を格納するために必要なバッファーのサイズ(バイト単位)。バッファーを必要なサイズまで拡張して、関数を再度呼び出してください。
その他	値は未定義であり、使用しないでください。

戻り値の型: DWORD

公式ドキュメント

指定したシステム上のカウンターセットに関する情報を取得します。

戻り値

戻り値コード	説明
ERROR_SUCCESS	関数はカウンターセットに関するすべての情報を pbRegInfo で指定したバッファーに正常に格納しました。pcbRegInfoActual が指す値は、実際にバッファーに格納された情報量(バイト単位)を示します。
ERROR_NOT_ENOUGH_MEMORY	pbRegInfo で指定したバッファーは、カウンターセットに関するすべての情報を格納するには十分な大きさではありませんでした。pcbRegInfoActual が指す値は、すべての情報を格納するために必要なバッファーのサイズを示します。バッファーを必要なサイズまで拡張して、関数を再度呼び出してください。

戻り値コード

説明

ERROR_SUCCESS

関数はカウンターセットに関するすべての情報を pbRegInfo で指定したバッファーに正常に格納しました。pcbRegInfoActual が指す値は、実際にバッファーに格納された情報量(バイト単位)を示します。

ERROR_NOT_ENOUGH_MEMORY

pbRegInfo で指定したバッファーは、カウンターセットに関するすべての情報を格納するには十分な大きさではありませんでした。pcbRegInfoActual が指す値は、すべての情報を格納するために必要なバッファーのサイズを示します。バッファーを必要なサイズまで拡張して、関数を再度呼び出してください。

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

解説(Remarks)

要求できるデータの種類と、各種類の要求に対して提供されるデータの形式については、PerfRegInfoType を参照してください。

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

各言語での呼び出し定義

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

DWORD PerfQueryCounterSetRegistrationInfo(
    LPCWSTR szMachine,   // optional
    const GUID* pCounterSetId,
    PerfRegInfoType requestCode,
    DWORD requestLangId,
    BYTE* pbRegInfo,   // optional
    DWORD cbRegInfo,
    DWORD* pcbRegInfoActual
);

[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint PerfQueryCounterSetRegistrationInfo(
    [MarshalAs(UnmanagedType.LPWStr)] string szMachine,   // LPCWSTR optional
    ref Guid pCounterSetId,   // GUID*
    int requestCode,   // PerfRegInfoType
    uint requestLangId,   // DWORD
    IntPtr pbRegInfo,   // BYTE* optional, out
    uint cbRegInfo,   // DWORD
    out uint pcbRegInfoActual   // DWORD* out
);

<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function PerfQueryCounterSetRegistrationInfo(
    <MarshalAs(UnmanagedType.LPWStr)> szMachine As String,   ' LPCWSTR optional
    ByRef pCounterSetId As Guid,   ' GUID*
    requestCode As Integer,   ' PerfRegInfoType
    requestLangId As UInteger,   ' DWORD
    pbRegInfo As IntPtr,   ' BYTE* optional, out
    cbRegInfo As UInteger,   ' DWORD
    <Out> ByRef pcbRegInfoActual As UInteger   ' DWORD* out
) As UInteger
End Function

' szMachine : LPCWSTR optional
' pCounterSetId : GUID*
' requestCode : PerfRegInfoType
' requestLangId : DWORD
' pbRegInfo : BYTE* optional, out
' cbRegInfo : DWORD
' pcbRegInfoActual : DWORD* out
Declare PtrSafe Function PerfQueryCounterSetRegistrationInfo Lib "advapi32" ( _
    ByVal szMachine As LongPtr, _
    ByVal pCounterSetId As LongPtr, _
    ByVal requestCode As Long, _
    ByVal requestLangId As Long, _
    ByVal pbRegInfo As LongPtr, _
    ByVal cbRegInfo As Long, _
    ByRef pcbRegInfoActual As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PerfQueryCounterSetRegistrationInfo = ctypes.windll.advapi32.PerfQueryCounterSetRegistrationInfo
PerfQueryCounterSetRegistrationInfo.restype = wintypes.DWORD
PerfQueryCounterSetRegistrationInfo.argtypes = [
    wintypes.LPCWSTR,  # szMachine : LPCWSTR optional
    ctypes.c_void_p,  # pCounterSetId : GUID*
    ctypes.c_int,  # requestCode : PerfRegInfoType
    wintypes.DWORD,  # requestLangId : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbRegInfo : BYTE* optional, out
    wintypes.DWORD,  # cbRegInfo : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbRegInfoActual : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
PerfQueryCounterSetRegistrationInfo = Fiddle::Function.new(
  lib['PerfQueryCounterSetRegistrationInfo'],
  [
    Fiddle::TYPE_VOIDP,  # szMachine : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # pCounterSetId : GUID*
    Fiddle::TYPE_INT,  # requestCode : PerfRegInfoType
    -Fiddle::TYPE_INT,  # requestLangId : DWORD
    Fiddle::TYPE_VOIDP,  # pbRegInfo : BYTE* optional, out
    -Fiddle::TYPE_INT,  # cbRegInfo : DWORD
    Fiddle::TYPE_VOIDP,  # pcbRegInfoActual : DWORD* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn PerfQueryCounterSetRegistrationInfo(
        szMachine: *const u16,  // LPCWSTR optional
        pCounterSetId: *const GUID,  // GUID*
        requestCode: i32,  // PerfRegInfoType
        requestLangId: u32,  // DWORD
        pbRegInfo: *mut u8,  // BYTE* optional, out
        cbRegInfo: u32,  // DWORD
        pcbRegInfoActual: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint PerfQueryCounterSetRegistrationInfo([MarshalAs(UnmanagedType.LPWStr)] string szMachine, ref Guid pCounterSetId, int requestCode, uint requestLangId, IntPtr pbRegInfo, uint cbRegInfo, out uint pcbRegInfoActual);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_PerfQueryCounterSetRegistrationInfo' -Namespace Win32 -PassThru
# $api::PerfQueryCounterSetRegistrationInfo(szMachine, pCounterSetId, requestCode, requestLangId, pbRegInfo, cbRegInfo, pcbRegInfoActual)

#uselib "ADVAPI32.dll"
#func global PerfQueryCounterSetRegistrationInfo "PerfQueryCounterSetRegistrationInfo" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; PerfQueryCounterSetRegistrationInfo szMachine, varptr(pCounterSetId), requestCode, requestLangId, varptr(pbRegInfo), cbRegInfo, varptr(pcbRegInfoActual)   ; 戻り値は stat
; szMachine : LPCWSTR optional -> "sptr"
; pCounterSetId : GUID* -> "sptr"
; requestCode : PerfRegInfoType -> "sptr"
; requestLangId : DWORD -> "sptr"
; pbRegInfo : BYTE* optional, out -> "sptr"
; cbRegInfo : DWORD -> "sptr"
; pcbRegInfoActual : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global PerfQueryCounterSetRegistrationInfo "PerfQueryCounterSetRegistrationInfo" wstr, var, int, int, var, int, var
; res = PerfQueryCounterSetRegistrationInfo(szMachine, pCounterSetId, requestCode, requestLangId, pbRegInfo, cbRegInfo, pcbRegInfoActual)
; szMachine : LPCWSTR optional -> "wstr"
; pCounterSetId : GUID* -> "var"
; requestCode : PerfRegInfoType -> "int"
; requestLangId : DWORD -> "int"
; pbRegInfo : BYTE* optional, out -> "var"
; cbRegInfo : DWORD -> "int"
; pcbRegInfoActual : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global PerfQueryCounterSetRegistrationInfo "PerfQueryCounterSetRegistrationInfo" wstr, sptr, int, int, sptr, int, sptr
; res = PerfQueryCounterSetRegistrationInfo(szMachine, varptr(pCounterSetId), requestCode, requestLangId, varptr(pbRegInfo), cbRegInfo, varptr(pcbRegInfoActual))
; szMachine : LPCWSTR optional -> "wstr"
; pCounterSetId : GUID* -> "sptr"
; requestCode : PerfRegInfoType -> "int"
; requestLangId : DWORD -> "int"
; pbRegInfo : BYTE* optional, out -> "sptr"
; cbRegInfo : DWORD -> "int"
; pcbRegInfoActual : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。