ホーム › System.Performance › PdhEnumObjectItemsW

PdhEnumObjectItemsW

関数

オブジェクトのカウンター名とインスタンス名を列挙する。

DLLpdh.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// pdh.dll  (Unicode / -W)
#include <windows.h>

DWORD PdhEnumObjectItemsW(
    LPCWSTR szDataSource,   // optional
    LPCWSTR szMachineName,   // optional
    LPCWSTR szObjectName,
    LPWSTR mszCounterList,   // optional
    DWORD* pcchCounterListLength,
    LPWSTR mszInstanceList,   // optional
    DWORD* pcchInstanceListLength,
    PERF_DETAIL dwDetailLevel,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

szDataSource

LPCWSTR

inoptional

カウンター名およびインスタンス名の列挙に使用するログファイルの名前を指定する Null 終端文字列です。NULL の場合、関数は szMachineName パラメーターで指定されたコンピューターを使用して名前を列挙します。

szMachineName

LPCWSTR

inoptional

列挙したいカウンター名およびインスタンス名を含むコンピューターの名前を指定する Null 終端文字列です。

コンピューター名には先頭のスラッシュを含めてください。例: \computername。

szDataSource パラメーターが NULL の場合、szMachineName を NULL に設定するとローカルコンピューターを指定できます。

szObjectName

LPCWSTR

カウンター名およびインスタンス名を列挙したいオブジェクトの名前を指定する Null 終端文字列です。

mszCounterList

LPWSTR

outoptional

指定オブジェクトが提供する null 終端のカウンター名のリストを受け取る、呼び出し側が割り当てたバッファーです。リストには一意のカウンター名が含まれます。リストは 2 つの NULL 文字で終端されます。pcchCounterListLength パラメーターが 0 の場合は NULL に設定してください。

pcchCounterListLength

DWORD*

inout

mszCounterList バッファーのサイズ(TCHAR 単位)です。入力時に 0 でオブジェクトが存在する場合、関数は PDH_MORE_DATA を返し、このパラメーターに必要なバッファーサイズを設定します。バッファーが必要なサイズより大きい場合、関数は実際に使用されたバッファーのサイズをこのパラメーターに設定します。入力時に指定したサイズが 0 より大きく必要なサイズ未満の場合、返されたサイズに基づいてバッファーを再割り当てしないでください。

mszInstanceList

LPWSTR

outoptional

指定オブジェクトが提供する null 終端のインスタンス名のリストを受け取る、呼び出し側が割り当てたバッファーです。リストには一意のインスタンス名が含まれます。リストは 2 つの NULL 文字で終端されます。pcchInstanceListLength が 0 の場合は NULL に設定してください。

pcchInstanceListLength

DWORD*

inout

mszInstanceList バッファーのサイズ(TCHAR 単位)です。入力時に 0 でオブジェクトが存在する場合、関数は PDH_MORE_DATA を返し、このパラメーターに必要なバッファーサイズを設定します。バッファーが必要なサイズより大きい場合、関数は実際に使用されたバッファーのサイズをこのパラメーターに設定します。入力時に指定したサイズが 0 より大きく必要なサイズ未満の場合、返されたサイズに基づいてバッファーを再割り当てしないでください。

指定オブジェクトが可変インスタンスをサポートしていない場合、返される値は 0 になります。指定オブジェクトが可変インスタンスをサポートしているものの、現在インスタンスが 1 つも存在しない場合、返される値は 2(空の MULTI_SZ リスト文字列のサイズ)になります。

dwDetailLevel

PERF_DETAIL

返す対象とするパフォーマンス項目の詳細レベルです。指定した詳細レベル以下のすべての項目が返されます(レベルは昇順に列挙されています)。このパラメーターには次のいずれかの値を指定できます。

Value	Meaning
PERF_DETAIL_NOVICE	初心者ユーザー向けの詳細レベル。
PERF_DETAIL_ADVANCED	上級ユーザー向けの詳細レベル。
PERF_DETAIL_EXPERT	熟練ユーザー向けの詳細レベル。
PERF_DETAIL_WIZARD	システム設計者向けの詳細レベル。

dwFlags

DWORD

このパラメーターは 0 でなければなりません。

戻り値の型: DWORD

公式ドキュメント

指定したコンピューター上、または指定したログファイル内に存在する、指定オブジェクトのカウンター名およびインスタンス名を返します。データソースへのハンドルを使用するには、PdhEnumObjectItemsH 関数を使用してください。(Unicode)

戻り値

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

関数が失敗した場合、戻り値はシステムエラーコードまたは PDH エラーコードです。次の値が返される可能性があります。

Return code	Description
PDH_MORE_DATA	いずれかのバッファーが名前のリストを格納するには小さすぎます。この戻り値は、入力時に pcchCounterListLength または pcchInstanceListLength が 0 の場合に想定されるものです。入力時に指定したサイズが 0 より大きく必要なサイズ未満の場合、返されたサイズに基づいてバッファーを再割り当てしないでください。
PDH_INVALID_ARGUMENT	パラメーターが無効です。例えば、一部のリリースでは、入力時に指定したサイズが 0 より大きく必要なサイズ未満の場合にこのエラーが返されることがあります。
PDH_MEMORY_ALLOCATION_FAILURE	この関数をサポートするためのメモリを割り当てられませんでした。
PDH_CSTATUS_NO_MACHINE	指定したコンピューターがオフラインまたは利用できません。
PDH_CSTATUS_NO_OBJECT	指定したオブジェクトが、指定したコンピューター上または指定したログファイル内に見つかりませんでした。

解説(Remarks)

この関数は 2 回呼び出す必要があります。1 回目は必要なバッファーサイズを取得するため(バッファーを NULL に、サイズを 0 に設定します)、2 回目はデータを取得するためです。

この関数を連続して呼び出すと、同一のカウンターおよびインスタンスのリストが返されます。これは、 PdhEnumObjectItems が常に、最後に呼び出した PdhEnumObjects または PdhEnumObjectItems によって定義されたパフォーマンスオブジェクトのリストを照会するためです。パフォーマンスオブジェクトのリストを更新するには、 PdhEnumObjectItems を再度呼び出す前に、bRefresh フラグ値を TRUE にして PdhEnumObjects を呼び出してください。

インスタンス名およびカウンター名の順序は不定です。

例

例については、 Enumerating Process Objects を参照してください。

メモ

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

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

各言語での呼び出し定義

// pdh.dll  (Unicode / -W)
#include <windows.h>

DWORD PdhEnumObjectItemsW(
    LPCWSTR szDataSource,   // optional
    LPCWSTR szMachineName,   // optional
    LPCWSTR szObjectName,
    LPWSTR mszCounterList,   // optional
    DWORD* pcchCounterListLength,
    LPWSTR mszInstanceList,   // optional
    DWORD* pcchInstanceListLength,
    PERF_DETAIL dwDetailLevel,
    DWORD dwFlags
);

[DllImport("pdh.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PdhEnumObjectItemsW(
    [MarshalAs(UnmanagedType.LPWStr)] string szDataSource,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string szMachineName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string szObjectName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszCounterList,   // LPWSTR optional, out
    ref uint pcchCounterListLength,   // DWORD* in/out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszInstanceList,   // LPWSTR optional, out
    ref uint pcchInstanceListLength,   // DWORD* in/out
    uint dwDetailLevel,   // PERF_DETAIL
    uint dwFlags   // DWORD
);

<DllImport("pdh.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PdhEnumObjectItemsW(
    <MarshalAs(UnmanagedType.LPWStr)> szDataSource As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> szMachineName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> szObjectName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> mszCounterList As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcchCounterListLength As UInteger,   ' DWORD* in/out
    <MarshalAs(UnmanagedType.LPWStr)> mszInstanceList As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcchInstanceListLength As UInteger,   ' DWORD* in/out
    dwDetailLevel As UInteger,   ' PERF_DETAIL
    dwFlags As UInteger   ' DWORD
) As UInteger
End Function

' szDataSource : LPCWSTR optional
' szMachineName : LPCWSTR optional
' szObjectName : LPCWSTR
' mszCounterList : LPWSTR optional, out
' pcchCounterListLength : DWORD* in/out
' mszInstanceList : LPWSTR optional, out
' pcchInstanceListLength : DWORD* in/out
' dwDetailLevel : PERF_DETAIL
' dwFlags : DWORD
Declare PtrSafe Function PdhEnumObjectItemsW Lib "pdh" ( _
    ByVal szDataSource As LongPtr, _
    ByVal szMachineName As LongPtr, _
    ByVal szObjectName As LongPtr, _
    ByVal mszCounterList As LongPtr, _
    ByRef pcchCounterListLength As Long, _
    ByVal mszInstanceList As LongPtr, _
    ByRef pcchInstanceListLength As Long, _
    ByVal dwDetailLevel As Long, _
    ByVal dwFlags As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhEnumObjectItemsW = ctypes.windll.pdh.PdhEnumObjectItemsW
PdhEnumObjectItemsW.restype = wintypes.DWORD
PdhEnumObjectItemsW.argtypes = [
    wintypes.LPCWSTR,  # szDataSource : LPCWSTR optional
    wintypes.LPCWSTR,  # szMachineName : LPCWSTR optional
    wintypes.LPCWSTR,  # szObjectName : LPCWSTR
    wintypes.LPWSTR,  # mszCounterList : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchCounterListLength : DWORD* in/out
    wintypes.LPWSTR,  # mszInstanceList : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchInstanceListLength : DWORD* in/out
    wintypes.DWORD,  # dwDetailLevel : PERF_DETAIL
    wintypes.DWORD,  # dwFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhEnumObjectItemsW = Fiddle::Function.new(
  lib['PdhEnumObjectItemsW'],
  [
    Fiddle::TYPE_VOIDP,  # szDataSource : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # szMachineName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # szObjectName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # mszCounterList : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchCounterListLength : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # mszInstanceList : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchInstanceListLength : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwDetailLevel : PERF_DETAIL
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "pdh")]
extern "system" {
    fn PdhEnumObjectItemsW(
        szDataSource: *const u16,  // LPCWSTR optional
        szMachineName: *const u16,  // LPCWSTR optional
        szObjectName: *const u16,  // LPCWSTR
        mszCounterList: *mut u16,  // LPWSTR optional, out
        pcchCounterListLength: *mut u32,  // DWORD* in/out
        mszInstanceList: *mut u16,  // LPWSTR optional, out
        pcchInstanceListLength: *mut u32,  // DWORD* in/out
        dwDetailLevel: u32,  // PERF_DETAIL
        dwFlags: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("pdh.dll", CharSet = CharSet.Unicode)]
public static extern uint PdhEnumObjectItemsW([MarshalAs(UnmanagedType.LPWStr)] string szDataSource, [MarshalAs(UnmanagedType.LPWStr)] string szMachineName, [MarshalAs(UnmanagedType.LPWStr)] string szObjectName, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszCounterList, ref uint pcchCounterListLength, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszInstanceList, ref uint pcchInstanceListLength, uint dwDetailLevel, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhEnumObjectItemsW' -Namespace Win32 -PassThru
# $api::PdhEnumObjectItemsW(szDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags)

#uselib "pdh.dll"
#func global PdhEnumObjectItemsW "PdhEnumObjectItemsW" wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr
; PdhEnumObjectItemsW szDataSource, szMachineName, szObjectName, varptr(mszCounterList), varptr(pcchCounterListLength), varptr(mszInstanceList), varptr(pcchInstanceListLength), dwDetailLevel, dwFlags   ; 戻り値は stat
; szDataSource : LPCWSTR optional -> "wptr"
; szMachineName : LPCWSTR optional -> "wptr"
; szObjectName : LPCWSTR -> "wptr"
; mszCounterList : LPWSTR optional, out -> "wptr"
; pcchCounterListLength : DWORD* in/out -> "wptr"
; mszInstanceList : LPWSTR optional, out -> "wptr"
; pcchInstanceListLength : DWORD* in/out -> "wptr"
; dwDetailLevel : PERF_DETAIL -> "wptr"
; dwFlags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "pdh.dll"
#cfunc global PdhEnumObjectItemsW "PdhEnumObjectItemsW" wstr, wstr, wstr, var, var, var, var, int, int
; res = PdhEnumObjectItemsW(szDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags)
; szDataSource : LPCWSTR optional -> "wstr"
; szMachineName : LPCWSTR optional -> "wstr"
; szObjectName : LPCWSTR -> "wstr"
; mszCounterList : LPWSTR optional, out -> "var"
; pcchCounterListLength : DWORD* in/out -> "var"
; mszInstanceList : LPWSTR optional, out -> "var"
; pcchInstanceListLength : DWORD* in/out -> "var"
; dwDetailLevel : PERF_DETAIL -> "int"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "pdh.dll"
#cfunc global PdhEnumObjectItemsW "PdhEnumObjectItemsW" wstr, wstr, wstr, sptr, sptr, sptr, sptr, int, int
; res = PdhEnumObjectItemsW(szDataSource, szMachineName, szObjectName, varptr(mszCounterList), varptr(pcchCounterListLength), varptr(mszInstanceList), varptr(pcchInstanceListLength), dwDetailLevel, dwFlags)
; szDataSource : LPCWSTR optional -> "wstr"
; szMachineName : LPCWSTR optional -> "wstr"
; szObjectName : LPCWSTR -> "wstr"
; mszCounterList : LPWSTR optional, out -> "sptr"
; pcchCounterListLength : DWORD* in/out -> "sptr"
; mszInstanceList : LPWSTR optional, out -> "sptr"
; pcchInstanceListLength : DWORD* in/out -> "sptr"
; dwDetailLevel : PERF_DETAIL -> "int"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; DWORD PdhEnumObjectItemsW(LPCWSTR szDataSource, LPCWSTR szMachineName, LPCWSTR szObjectName, LPWSTR mszCounterList, DWORD* pcchCounterListLength, LPWSTR mszInstanceList, DWORD* pcchInstanceListLength, PERF_DETAIL dwDetailLevel, DWORD dwFlags)
#uselib "pdh.dll"
#cfunc global PdhEnumObjectItemsW "PdhEnumObjectItemsW" wstr, wstr, wstr, var, var, var, var, int, int
; res = PdhEnumObjectItemsW(szDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags)
; szDataSource : LPCWSTR optional -> "wstr"
; szMachineName : LPCWSTR optional -> "wstr"
; szObjectName : LPCWSTR -> "wstr"
; mszCounterList : LPWSTR optional, out -> "var"
; pcchCounterListLength : DWORD* in/out -> "var"
; mszInstanceList : LPWSTR optional, out -> "var"
; pcchInstanceListLength : DWORD* in/out -> "var"
; dwDetailLevel : PERF_DETAIL -> "int"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD PdhEnumObjectItemsW(LPCWSTR szDataSource, LPCWSTR szMachineName, LPCWSTR szObjectName, LPWSTR mszCounterList, DWORD* pcchCounterListLength, LPWSTR mszInstanceList, DWORD* pcchInstanceListLength, PERF_DETAIL dwDetailLevel, DWORD dwFlags)
#uselib "pdh.dll"
#cfunc global PdhEnumObjectItemsW "PdhEnumObjectItemsW" wstr, wstr, wstr, intptr, intptr, intptr, intptr, int, int
; res = PdhEnumObjectItemsW(szDataSource, szMachineName, szObjectName, varptr(mszCounterList), varptr(pcchCounterListLength), varptr(mszInstanceList), varptr(pcchInstanceListLength), dwDetailLevel, dwFlags)
; szDataSource : LPCWSTR optional -> "wstr"
; szMachineName : LPCWSTR optional -> "wstr"
; szObjectName : LPCWSTR -> "wstr"
; mszCounterList : LPWSTR optional, out -> "intptr"
; pcchCounterListLength : DWORD* in/out -> "intptr"
; mszInstanceList : LPWSTR optional, out -> "intptr"
; pcchInstanceListLength : DWORD* in/out -> "intptr"
; dwDetailLevel : PERF_DETAIL -> "int"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	pdh = windows.NewLazySystemDLL("pdh.dll")
	procPdhEnumObjectItemsW = pdh.NewProc("PdhEnumObjectItemsW")
)

// szDataSource (LPCWSTR optional), szMachineName (LPCWSTR optional), szObjectName (LPCWSTR), mszCounterList (LPWSTR optional, out), pcchCounterListLength (DWORD* in/out), mszInstanceList (LPWSTR optional, out), pcchInstanceListLength (DWORD* in/out), dwDetailLevel (PERF_DETAIL), dwFlags (DWORD)
r1, _, err := procPdhEnumObjectItemsW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szDataSource))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szMachineName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szObjectName))),
	uintptr(mszCounterList),
	uintptr(pcchCounterListLength),
	uintptr(mszInstanceList),
	uintptr(pcchInstanceListLength),
	uintptr(dwDetailLevel),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function PdhEnumObjectItemsW(
  szDataSource: PWideChar;   // LPCWSTR optional
  szMachineName: PWideChar;   // LPCWSTR optional
  szObjectName: PWideChar;   // LPCWSTR
  mszCounterList: PWideChar;   // LPWSTR optional, out
  pcchCounterListLength: Pointer;   // DWORD* in/out
  mszInstanceList: PWideChar;   // LPWSTR optional, out
  pcchInstanceListLength: Pointer;   // DWORD* in/out
  dwDetailLevel: DWORD;   // PERF_DETAIL
  dwFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'pdh.dll' name 'PdhEnumObjectItemsW';

result := DllCall("pdh\PdhEnumObjectItemsW"
    , "WStr", szDataSource   ; LPCWSTR optional
    , "WStr", szMachineName   ; LPCWSTR optional
    , "WStr", szObjectName   ; LPCWSTR
    , "Ptr", mszCounterList   ; LPWSTR optional, out
    , "Ptr", pcchCounterListLength   ; DWORD* in/out
    , "Ptr", mszInstanceList   ; LPWSTR optional, out
    , "Ptr", pcchInstanceListLength   ; DWORD* in/out
    , "UInt", dwDetailLevel   ; PERF_DETAIL
    , "UInt", dwFlags   ; DWORD
    , "UInt")   ; return: DWORD

●PdhEnumObjectItemsW(szDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags) = DLL("pdh.dll", "dword PdhEnumObjectItemsW(char*, char*, char*, char*, void*, char*, void*, dword, dword)")
# 呼び出し: PdhEnumObjectItemsW(szDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags)
# szDataSource : LPCWSTR optional -> "char*"
# szMachineName : LPCWSTR optional -> "char*"
# szObjectName : LPCWSTR -> "char*"
# mszCounterList : LPWSTR optional, out -> "char*"
# pcchCounterListLength : DWORD* in/out -> "void*"
# mszInstanceList : LPWSTR optional, out -> "char*"
# pcchInstanceListLength : DWORD* in/out -> "void*"
# dwDetailLevel : PERF_DETAIL -> "dword"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。

const std = @import("std");

extern "pdh" fn PdhEnumObjectItemsW(
    szDataSource: [*c]const u16, // LPCWSTR optional
    szMachineName: [*c]const u16, // LPCWSTR optional
    szObjectName: [*c]const u16, // LPCWSTR
    mszCounterList: [*c]u16, // LPWSTR optional, out
    pcchCounterListLength: [*c]u32, // DWORD* in/out
    mszInstanceList: [*c]u16, // LPWSTR optional, out
    pcchInstanceListLength: [*c]u32, // DWORD* in/out
    dwDetailLevel: u32, // PERF_DETAIL
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。

proc PdhEnumObjectItemsW(
    szDataSource: WideCString,  # LPCWSTR optional
    szMachineName: WideCString,  # LPCWSTR optional
    szObjectName: WideCString,  # LPCWSTR
    mszCounterList: ptr uint16,  # LPWSTR optional, out
    pcchCounterListLength: ptr uint32,  # DWORD* in/out
    mszInstanceList: ptr uint16,  # LPWSTR optional, out
    pcchInstanceListLength: ptr uint32,  # DWORD* in/out
    dwDetailLevel: uint32,  # PERF_DETAIL
    dwFlags: uint32  # DWORD
): uint32 {.importc: "PdhEnumObjectItemsW", stdcall, dynlib: "pdh.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。

pragma(lib, "pdh");
extern(Windows)
uint PdhEnumObjectItemsW(
    const(wchar)* szDataSource,   // LPCWSTR optional
    const(wchar)* szMachineName,   // LPCWSTR optional
    const(wchar)* szObjectName,   // LPCWSTR
    wchar* mszCounterList,   // LPWSTR optional, out
    uint* pcchCounterListLength,   // DWORD* in/out
    wchar* mszInstanceList,   // LPWSTR optional, out
    uint* pcchInstanceListLength,   // DWORD* in/out
    uint dwDetailLevel,   // PERF_DETAIL
    uint dwFlags   // DWORD
);

ccall((:PdhEnumObjectItemsW, "pdh.dll"), stdcall, UInt32,
      (Cwstring, Cwstring, Cwstring, Ptr{UInt16}, Ptr{UInt32}, Ptr{UInt16}, Ptr{UInt32}, UInt32, UInt32),
      szDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags)
# szDataSource : LPCWSTR optional -> Cwstring
# szMachineName : LPCWSTR optional -> Cwstring
# szObjectName : LPCWSTR -> Cwstring
# mszCounterList : LPWSTR optional, out -> Ptr{UInt16}
# pcchCounterListLength : DWORD* in/out -> Ptr{UInt32}
# mszInstanceList : LPWSTR optional, out -> Ptr{UInt16}
# pcchInstanceListLength : DWORD* in/out -> Ptr{UInt32}
# dwDetailLevel : PERF_DETAIL -> UInt32
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。

local ffi = require("ffi")
ffi.cdef[[
uint32_t PdhEnumObjectItemsW(
    const uint16_t* szDataSource,
    const uint16_t* szMachineName,
    const uint16_t* szObjectName,
    uint16_t* mszCounterList,
    uint32_t* pcchCounterListLength,
    uint16_t* mszInstanceList,
    uint32_t* pcchInstanceListLength,
    uint32_t dwDetailLevel,
    uint32_t dwFlags);
]]
local pdh = ffi.load("pdh")
-- pdh.PdhEnumObjectItemsW(szDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags)
-- szDataSource : LPCWSTR optional
-- szMachineName : LPCWSTR optional
-- szObjectName : LPCWSTR
-- mszCounterList : LPWSTR optional, out
-- pcchCounterListLength : DWORD* in/out
-- mszInstanceList : LPWSTR optional, out
-- pcchInstanceListLength : DWORD* in/out
-- dwDetailLevel : PERF_DETAIL
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。

const koffi = require('koffi');
const lib = koffi.load('pdh.dll');
const PdhEnumObjectItemsW = lib.func('__stdcall', 'PdhEnumObjectItemsW', 'uint32_t', ['str16', 'str16', 'str16', 'uint16_t *', 'uint32_t *', 'uint16_t *', 'uint32_t *', 'uint32_t', 'uint32_t']);
// PdhEnumObjectItemsW(szDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags)
// szDataSource : LPCWSTR optional -> 'str16'
// szMachineName : LPCWSTR optional -> 'str16'
// szObjectName : LPCWSTR -> 'str16'
// mszCounterList : LPWSTR optional, out -> 'uint16_t *'
// pcchCounterListLength : DWORD* in/out -> 'uint32_t *'
// mszInstanceList : LPWSTR optional, out -> 'uint16_t *'
// pcchInstanceListLength : DWORD* in/out -> 'uint32_t *'
// dwDetailLevel : PERF_DETAIL -> 'uint32_t'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("pdh.dll", {
  PdhEnumObjectItemsW: { parameters: ["buffer", "buffer", "buffer", "buffer", "pointer", "buffer", "pointer", "u32", "u32"], result: "u32" },
});
// lib.symbols.PdhEnumObjectItemsW(szDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags)
// szDataSource : LPCWSTR optional -> "buffer"
// szMachineName : LPCWSTR optional -> "buffer"
// szObjectName : LPCWSTR -> "buffer"
// mszCounterList : LPWSTR optional, out -> "buffer"
// pcchCounterListLength : DWORD* in/out -> "pointer"
// mszInstanceList : LPWSTR optional, out -> "buffer"
// pcchInstanceListLength : DWORD* in/out -> "pointer"
// dwDetailLevel : PERF_DETAIL -> "u32"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
uint32_t PdhEnumObjectItemsW(
    const uint16_t* szDataSource,
    const uint16_t* szMachineName,
    const uint16_t* szObjectName,
    uint16_t* mszCounterList,
    uint32_t* pcchCounterListLength,
    uint16_t* mszInstanceList,
    uint32_t* pcchInstanceListLength,
    uint32_t dwDetailLevel,
    uint32_t dwFlags);
C, "pdh.dll");
// $ffi->PdhEnumObjectItemsW(szDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags);
// szDataSource : LPCWSTR optional
// szMachineName : LPCWSTR optional
// szObjectName : LPCWSTR
// mszCounterList : LPWSTR optional, out
// pcchCounterListLength : DWORD* in/out
// mszInstanceList : LPWSTR optional, out
// pcchInstanceListLength : DWORD* in/out
// dwDetailLevel : PERF_DETAIL
// dwFlags : DWORD
// 構造体/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.UNICODE_OPTIONS);
    int PdhEnumObjectItemsW(
        WString szDataSource,   // LPCWSTR optional
        WString szMachineName,   // LPCWSTR optional
        WString szObjectName,   // LPCWSTR
        char[] mszCounterList,   // LPWSTR optional, out
        IntByReference pcchCounterListLength,   // DWORD* in/out
        char[] mszInstanceList,   // LPWSTR optional, out
        IntByReference pcchInstanceListLength,   // DWORD* in/out
        int dwDetailLevel,   // PERF_DETAIL
        int dwFlags   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。

@[Link("pdh")]
lib Libpdh
  fun PdhEnumObjectItemsW = PdhEnumObjectItemsW(
    szDataSource : UInt16*,   # LPCWSTR optional
    szMachineName : UInt16*,   # LPCWSTR optional
    szObjectName : UInt16*,   # LPCWSTR
    mszCounterList : UInt16*,   # LPWSTR optional, out
    pcchCounterListLength : UInt32*,   # DWORD* in/out
    mszInstanceList : UInt16*,   # LPWSTR optional, out
    pcchInstanceListLength : UInt32*,   # DWORD* in/out
    dwDetailLevel : UInt32,   # PERF_DETAIL
    dwFlags : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PdhEnumObjectItemsWNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Uint32>, Pointer<Utf16>, Pointer<Uint32>, Uint32, Uint32);
typedef PdhEnumObjectItemsWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Uint32>, Pointer<Utf16>, Pointer<Uint32>, int, int);
final PdhEnumObjectItemsW = DynamicLibrary.open('pdh.dll')
    .lookupFunction<PdhEnumObjectItemsWNative, PdhEnumObjectItemsWDart>('PdhEnumObjectItemsW');
// szDataSource : LPCWSTR optional -> Pointer<Utf16>
// szMachineName : LPCWSTR optional -> Pointer<Utf16>
// szObjectName : LPCWSTR -> Pointer<Utf16>
// mszCounterList : LPWSTR optional, out -> Pointer<Utf16>
// pcchCounterListLength : DWORD* in/out -> Pointer<Uint32>
// mszInstanceList : LPWSTR optional, out -> Pointer<Utf16>
// pcchInstanceListLength : DWORD* in/out -> Pointer<Uint32>
// dwDetailLevel : PERF_DETAIL -> Uint32
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function PdhEnumObjectItemsW(
  szDataSource: PWideChar;   // LPCWSTR optional
  szMachineName: PWideChar;   // LPCWSTR optional
  szObjectName: PWideChar;   // LPCWSTR
  mszCounterList: PWideChar;   // LPWSTR optional, out
  pcchCounterListLength: Pointer;   // DWORD* in/out
  mszInstanceList: PWideChar;   // LPWSTR optional, out
  pcchInstanceListLength: Pointer;   // DWORD* in/out
  dwDetailLevel: DWORD;   // PERF_DETAIL
  dwFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'pdh.dll' name 'PdhEnumObjectItemsW';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PdhEnumObjectItemsW"
  c_PdhEnumObjectItemsW :: CWString -> CWString -> CWString -> CWString -> Ptr Word32 -> CWString -> Ptr Word32 -> Word32 -> Word32 -> IO Word32
-- szDataSource : LPCWSTR optional -> CWString
-- szMachineName : LPCWSTR optional -> CWString
-- szObjectName : LPCWSTR -> CWString
-- mszCounterList : LPWSTR optional, out -> CWString
-- pcchCounterListLength : DWORD* in/out -> Ptr Word32
-- mszInstanceList : LPWSTR optional, out -> CWString
-- pcchInstanceListLength : DWORD* in/out -> Ptr Word32
-- dwDetailLevel : PERF_DETAIL -> Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let pdhenumobjectitemsw =
  foreign "PdhEnumObjectItemsW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint32_t) @-> (ptr uint16_t) @-> (ptr uint32_t) @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* szDataSource : LPCWSTR optional -> (ptr uint16_t) *)
(* szMachineName : LPCWSTR optional -> (ptr uint16_t) *)
(* szObjectName : LPCWSTR -> (ptr uint16_t) *)
(* mszCounterList : LPWSTR optional, out -> (ptr uint16_t) *)
(* pcchCounterListLength : DWORD* in/out -> (ptr uint32_t) *)
(* mszInstanceList : LPWSTR optional, out -> (ptr uint16_t) *)
(* pcchInstanceListLength : DWORD* in/out -> (ptr uint32_t) *)
(* dwDetailLevel : PERF_DETAIL -> uint32_t *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library pdh (t "pdh.dll"))
(cffi:use-foreign-library pdh)

(cffi:defcfun ("PdhEnumObjectItemsW" pdh-enum-object-items-w :convention :stdcall) :uint32
  (sz-data-source (:string :encoding :utf-16le))   ; LPCWSTR optional
  (sz-machine-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (sz-object-name (:string :encoding :utf-16le))   ; LPCWSTR
  (msz-counter-list :pointer)   ; LPWSTR optional, out
  (pcch-counter-list-length :pointer)   ; DWORD* in/out
  (msz-instance-list :pointer)   ; LPWSTR optional, out
  (pcch-instance-list-length :pointer)   ; DWORD* in/out
  (dw-detail-level :uint32)   ; PERF_DETAIL
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $PdhEnumObjectItemsW = Win32::API::More->new('pdh',
    'DWORD PdhEnumObjectItemsW(LPCWSTR szDataSource, LPCWSTR szMachineName, LPCWSTR szObjectName, LPWSTR mszCounterList, LPVOID pcchCounterListLength, LPWSTR mszInstanceList, LPVOID pcchInstanceListLength, DWORD dwDetailLevel, DWORD dwFlags)');
# my $ret = $PdhEnumObjectItemsW->Call($szDataSource, $szMachineName, $szObjectName, $mszCounterList, $pcchCounterListLength, $mszInstanceList, $pcchInstanceListLength, $dwDetailLevel, $dwFlags);
# szDataSource : LPCWSTR optional -> LPCWSTR
# szMachineName : LPCWSTR optional -> LPCWSTR
# szObjectName : LPCWSTR -> LPCWSTR
# mszCounterList : LPWSTR optional, out -> LPWSTR
# pcchCounterListLength : DWORD* in/out -> LPVOID
# mszInstanceList : LPWSTR optional, out -> LPWSTR
# pcchInstanceListLength : DWORD* in/out -> LPVOID
# dwDetailLevel : PERF_DETAIL -> DWORD
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

PdhEnumObjectItemsW

シグネチャ

パラメーター

公式ドキュメント

戻り値

解説(Remarks)

例

各言語での呼び出し定義

関連項目