ホーム › System.Performance › PerfCreateInstance

PerfCreateInstance

関数

カウンタセットの新しいインスタンスを作成する。

DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

PERF_COUNTERSET_INSTANCE* PerfCreateInstance(
    HANDLE ProviderHandle,
    const GUID* CounterSetGuid,
    LPCWSTR Name,
    DWORD Id
);

パラメーター

名前	型	方向	説明
ProviderHandle	HANDLE	in	プロバイダーのハンドル。CTRPP ツールが生成したハンドル変数を使用します。変数名については、provider 要素の symbol 属性を参照してください。 Windows Vista: PerfStartProvider 関数がハンドルを返します。
CounterSetGuid	GUID*	in	作成するインスタンスのカウンターセットを一意に識別する GUID。これは counterSet 要素の guid 属性で指定したものと同じ GUID です。CTRPP ツールが生成した GUID 変数を使用します。変数名については、counterSet 要素の symbol 属性を参照してください。 Windows Vista: GUID 変数は利用できません。
Name	LPCWSTR	in	このインスタンスの一意の名前を含む Null 終端の Unicode 文字列。
Id	DWORD	in	このカウンターセットインスタンスの一意の識別子。識別子には、新しいインスタンスごとにインクリメントする連番を使用できます。

戻り値の型: PERF_COUNTERSET_INSTANCE*

公式ドキュメント

指定したカウンターセットのインスタンスを作成します。

戻り値

カウンターセットのインスタンスを含む PERF_COUNTERSET_INSTANCE 構造体。PERFLIB がインスタンスを作成できなかった場合は NULL を返します。このポインターをキャッシュしておき、後続の呼び出しで PerfQueryInstance を呼び出してインスタンスへのポインターを取得する代わりに使用してください。

エラーが発生した場合、この関数は NULL を返します。発生したエラーを特定するには、GetLastError を呼び出します。

解説(Remarks)

インスタンスをいつ作成するかはプロバイダーが決定します。カウンターデータが比較的静的であれば、プロバイダーは初期化時にインスタンスを作成できます。たとえば、コンピューター上のプロセッサ数は静的とみなせるため、プロセッサのカウンターデータを提供するプロバイダーは、初期化時にコンピューター上の各プロセッサに対してインスタンスを作成できます。ディスクやプロセスのカウンターのようにより動的なカウンターでは、新しい USB デバイスが追加されたときや新しいプロセスが作成されたときに、プロバイダーが新しいインスタンスを作成します。

プロバイダーがこの関数を呼び出すと、PERFLIB は新しいインスタンス用のローカルメモリを割り当て、インスタンスブロックを構築します。PERFLIB は、プロバイダーが PerfDeleteInstance 関数を呼び出したときにメモリを削除します。

インスタンスには生のカウンターデータが含まれます。プロバイダーは次の 3 つの関数を使用して生のカウンターデータを更新します。

通常、プロバイダーはカウンターデータを常に最新の状態に保ちます。代わりに、プロバイダーは ControlCallback 関数を実装し、PERF_COLLECT_START 要求コードを使用して更新をトリガーすることもできます。

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

各言語での呼び出し定義

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

PERF_COUNTERSET_INSTANCE* PerfCreateInstance(
    HANDLE ProviderHandle,
    const GUID* CounterSetGuid,
    LPCWSTR Name,
    DWORD Id
);

[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr PerfCreateInstance(
    IntPtr ProviderHandle,   // HANDLE
    ref Guid CounterSetGuid,   // GUID*
    [MarshalAs(UnmanagedType.LPWStr)] string Name,   // LPCWSTR
    uint Id   // DWORD
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function PerfCreateInstance(
    ProviderHandle As IntPtr,   ' HANDLE
    ByRef CounterSetGuid As Guid,   ' GUID*
    <MarshalAs(UnmanagedType.LPWStr)> Name As String,   ' LPCWSTR
    Id As UInteger   ' DWORD
) As IntPtr
End Function

' ProviderHandle : HANDLE
' CounterSetGuid : GUID*
' Name : LPCWSTR
' Id : DWORD
Declare PtrSafe Function PerfCreateInstance Lib "advapi32" ( _
    ByVal ProviderHandle As LongPtr, _
    ByVal CounterSetGuid As LongPtr, _
    ByVal Name As LongPtr, _
    ByVal Id As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PerfCreateInstance = ctypes.windll.advapi32.PerfCreateInstance
PerfCreateInstance.restype = ctypes.c_void_p
PerfCreateInstance.argtypes = [
    wintypes.HANDLE,  # ProviderHandle : HANDLE
    ctypes.c_void_p,  # CounterSetGuid : GUID*
    wintypes.LPCWSTR,  # Name : LPCWSTR
    wintypes.DWORD,  # Id : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
PerfCreateInstance = Fiddle::Function.new(
  lib['PerfCreateInstance'],
  [
    Fiddle::TYPE_VOIDP,  # ProviderHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # CounterSetGuid : GUID*
    Fiddle::TYPE_VOIDP,  # Name : LPCWSTR
    -Fiddle::TYPE_INT,  # Id : DWORD
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "advapi32")]
extern "system" {
    fn PerfCreateInstance(
        ProviderHandle: *mut core::ffi::c_void,  // HANDLE
        CounterSetGuid: *const GUID,  // GUID*
        Name: *const u16,  // LPCWSTR
        Id: u32  // DWORD
    ) -> *mut PERF_COUNTERSET_INSTANCE;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll", SetLastError = true)]
public static extern IntPtr PerfCreateInstance(IntPtr ProviderHandle, ref Guid CounterSetGuid, [MarshalAs(UnmanagedType.LPWStr)] string Name, uint Id);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_PerfCreateInstance' -Namespace Win32 -PassThru
# $api::PerfCreateInstance(ProviderHandle, CounterSetGuid, Name, Id)

#uselib "ADVAPI32.dll"
#func global PerfCreateInstance "PerfCreateInstance" sptr, sptr, sptr, sptr
; PerfCreateInstance ProviderHandle, varptr(CounterSetGuid), Name, Id   ; 戻り値は stat
; ProviderHandle : HANDLE -> "sptr"
; CounterSetGuid : GUID* -> "sptr"
; Name : LPCWSTR -> "sptr"
; Id : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global PerfCreateInstance "PerfCreateInstance" sptr, var, wstr, int
; res = PerfCreateInstance(ProviderHandle, CounterSetGuid, Name, Id)
; ProviderHandle : HANDLE -> "sptr"
; CounterSetGuid : GUID* -> "var"
; Name : LPCWSTR -> "wstr"
; Id : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global PerfCreateInstance "PerfCreateInstance" sptr, sptr, wstr, int
; res = PerfCreateInstance(ProviderHandle, varptr(CounterSetGuid), Name, Id)
; ProviderHandle : HANDLE -> "sptr"
; CounterSetGuid : GUID* -> "sptr"
; Name : LPCWSTR -> "wstr"
; Id : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。