ホーム › System.Performance › PdhEnumObjectItemsA

PdhEnumObjectItemsA

関数

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

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

シグネチャ

// pdh.dll  (ANSI / -A)
#include <windows.h>

DWORD PdhEnumObjectItemsA(
    LPCSTR szDataSource,   // optional
    LPCSTR szMachineName,   // optional
    LPCSTR szObjectName,
    LPSTR mszCounterList,   // optional
    DWORD* pcchCounterListLength,
    LPSTR mszInstanceList,   // optional
    DWORD* pcchInstanceListLength,
    PERF_DETAIL dwDetailLevel,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

szDataSource

LPCSTR

inoptional

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

szMachineName

LPCSTR

inoptional

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

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

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

szObjectName

LPCSTR

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

mszCounterList

LPSTR

outoptional

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

pcchCounterListLength

DWORD*

inout

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

mszInstanceList

LPSTR

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 関数を使用してください。(ANSI)

戻り値

関数が成功した場合、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 を呼び出してください。

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

Examples

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

メモ

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

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

各言語での呼び出し定義

// pdh.dll  (ANSI / -A)
#include <windows.h>

DWORD PdhEnumObjectItemsA(
    LPCSTR szDataSource,   // optional
    LPCSTR szMachineName,   // optional
    LPCSTR szObjectName,
    LPSTR mszCounterList,   // optional
    DWORD* pcchCounterListLength,
    LPSTR mszInstanceList,   // optional
    DWORD* pcchInstanceListLength,
    PERF_DETAIL dwDetailLevel,
    DWORD dwFlags
);

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

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

' szDataSource : LPCSTR optional
' szMachineName : LPCSTR optional
' szObjectName : LPCSTR
' mszCounterList : LPSTR optional, out
' pcchCounterListLength : DWORD* in/out
' mszInstanceList : LPSTR optional, out
' pcchInstanceListLength : DWORD* in/out
' dwDetailLevel : PERF_DETAIL
' dwFlags : DWORD
Declare PtrSafe Function PdhEnumObjectItemsA Lib "pdh" ( _
    ByVal szDataSource As String, _
    ByVal szMachineName As String, _
    ByVal szObjectName As String, _
    ByVal mszCounterList As String, _
    ByRef pcchCounterListLength As Long, _
    ByVal mszInstanceList As String, _
    ByRef pcchInstanceListLength As Long, _
    ByVal dwDetailLevel As Long, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhEnumObjectItemsA = ctypes.windll.pdh.PdhEnumObjectItemsA
PdhEnumObjectItemsA.restype = wintypes.DWORD
PdhEnumObjectItemsA.argtypes = [
    wintypes.LPCSTR,  # szDataSource : LPCSTR optional
    wintypes.LPCSTR,  # szMachineName : LPCSTR optional
    wintypes.LPCSTR,  # szObjectName : LPCSTR
    wintypes.LPSTR,  # mszCounterList : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchCounterListLength : DWORD* in/out
    wintypes.LPSTR,  # mszInstanceList : LPSTR 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')
PdhEnumObjectItemsA = Fiddle::Function.new(
  lib['PdhEnumObjectItemsA'],
  [
    Fiddle::TYPE_VOIDP,  # szDataSource : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # szMachineName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # szObjectName : LPCSTR
    Fiddle::TYPE_VOIDP,  # mszCounterList : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchCounterListLength : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # mszInstanceList : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchInstanceListLength : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwDetailLevel : PERF_DETAIL
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhEnumObjectItemsA(
        szDataSource: *const u8,  // LPCSTR optional
        szMachineName: *const u8,  // LPCSTR optional
        szObjectName: *const u8,  // LPCSTR
        mszCounterList: *mut u8,  // LPSTR optional, out
        pcchCounterListLength: *mut u32,  // DWORD* in/out
        mszInstanceList: *mut u8,  // LPSTR 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.Ansi)]
public static extern uint PdhEnumObjectItemsA([MarshalAs(UnmanagedType.LPStr)] string szDataSource, [MarshalAs(UnmanagedType.LPStr)] string szMachineName, [MarshalAs(UnmanagedType.LPStr)] string szObjectName, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder mszCounterList, ref uint pcchCounterListLength, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder mszInstanceList, ref uint pcchInstanceListLength, uint dwDetailLevel, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhEnumObjectItemsA' -Namespace Win32 -PassThru
# $api::PdhEnumObjectItemsA(szDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags)

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

出力引数:

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

出力引数:

; DWORD PdhEnumObjectItemsA(LPCSTR szDataSource, LPCSTR szMachineName, LPCSTR szObjectName, LPSTR mszCounterList, DWORD* pcchCounterListLength, LPSTR mszInstanceList, DWORD* pcchInstanceListLength, PERF_DETAIL dwDetailLevel, DWORD dwFlags)
#uselib "pdh.dll"
#cfunc global PdhEnumObjectItemsA "PdhEnumObjectItemsA" str, str, str, var, var, var, var, int, int
; res = PdhEnumObjectItemsA(szDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags)
; szDataSource : LPCSTR optional -> "str"
; szMachineName : LPCSTR optional -> "str"
; szObjectName : LPCSTR -> "str"
; mszCounterList : LPSTR optional, out -> "var"
; pcchCounterListLength : DWORD* in/out -> "var"
; mszInstanceList : LPSTR optional, out -> "var"
; pcchInstanceListLength : DWORD* in/out -> "var"
; dwDetailLevel : PERF_DETAIL -> "int"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD PdhEnumObjectItemsA(LPCSTR szDataSource, LPCSTR szMachineName, LPCSTR szObjectName, LPSTR mszCounterList, DWORD* pcchCounterListLength, LPSTR mszInstanceList, DWORD* pcchInstanceListLength, PERF_DETAIL dwDetailLevel, DWORD dwFlags)
#uselib "pdh.dll"
#cfunc global PdhEnumObjectItemsA "PdhEnumObjectItemsA" str, str, str, intptr, intptr, intptr, intptr, int, int
; res = PdhEnumObjectItemsA(szDataSource, szMachineName, szObjectName, varptr(mszCounterList), varptr(pcchCounterListLength), varptr(mszInstanceList), varptr(pcchInstanceListLength), dwDetailLevel, dwFlags)
; szDataSource : LPCSTR optional -> "str"
; szMachineName : LPCSTR optional -> "str"
; szObjectName : LPCSTR -> "str"
; mszCounterList : LPSTR optional, out -> "intptr"
; pcchCounterListLength : DWORD* in/out -> "intptr"
; mszInstanceList : LPSTR 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")
	procPdhEnumObjectItemsA = pdh.NewProc("PdhEnumObjectItemsA")
)

// szDataSource (LPCSTR optional), szMachineName (LPCSTR optional), szObjectName (LPCSTR), mszCounterList (LPSTR optional, out), pcchCounterListLength (DWORD* in/out), mszInstanceList (LPSTR optional, out), pcchInstanceListLength (DWORD* in/out), dwDetailLevel (PERF_DETAIL), dwFlags (DWORD)
r1, _, err := procPdhEnumObjectItemsA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szDataSource))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szMachineName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(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 PdhEnumObjectItemsA(
  szDataSource: PAnsiChar;   // LPCSTR optional
  szMachineName: PAnsiChar;   // LPCSTR optional
  szObjectName: PAnsiChar;   // LPCSTR
  mszCounterList: PAnsiChar;   // LPSTR optional, out
  pcchCounterListLength: Pointer;   // DWORD* in/out
  mszInstanceList: PAnsiChar;   // LPSTR optional, out
  pcchInstanceListLength: Pointer;   // DWORD* in/out
  dwDetailLevel: DWORD;   // PERF_DETAIL
  dwFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'pdh.dll' name 'PdhEnumObjectItemsA';

result := DllCall("pdh\PdhEnumObjectItemsA"
    , "AStr", szDataSource   ; LPCSTR optional
    , "AStr", szMachineName   ; LPCSTR optional
    , "AStr", szObjectName   ; LPCSTR
    , "Ptr", mszCounterList   ; LPSTR optional, out
    , "Ptr", pcchCounterListLength   ; DWORD* in/out
    , "Ptr", mszInstanceList   ; LPSTR optional, out
    , "Ptr", pcchInstanceListLength   ; DWORD* in/out
    , "UInt", dwDetailLevel   ; PERF_DETAIL
    , "UInt", dwFlags   ; DWORD
    , "UInt")   ; return: DWORD

●PdhEnumObjectItemsA(szDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags) = DLL("pdh.dll", "dword PdhEnumObjectItemsA(char*, char*, char*, char*, void*, char*, void*, dword, dword)")
# 呼び出し: PdhEnumObjectItemsA(szDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags)
# szDataSource : LPCSTR optional -> "char*"
# szMachineName : LPCSTR optional -> "char*"
# szObjectName : LPCSTR -> "char*"
# mszCounterList : LPSTR optional, out -> "char*"
# pcchCounterListLength : DWORD* in/out -> "void*"
# mszInstanceList : LPSTR optional, out -> "char*"
# pcchInstanceListLength : DWORD* in/out -> "void*"
# dwDetailLevel : PERF_DETAIL -> "dword"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "pdh" fn PdhEnumObjectItemsA(
    szDataSource: [*c]const u8, // LPCSTR optional
    szMachineName: [*c]const u8, // LPCSTR optional
    szObjectName: [*c]const u8, // LPCSTR
    mszCounterList: [*c]u8, // LPSTR optional, out
    pcchCounterListLength: [*c]u32, // DWORD* in/out
    mszInstanceList: [*c]u8, // LPSTR optional, out
    pcchInstanceListLength: [*c]u32, // DWORD* in/out
    dwDetailLevel: u32, // PERF_DETAIL
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;

proc PdhEnumObjectItemsA(
    szDataSource: cstring,  # LPCSTR optional
    szMachineName: cstring,  # LPCSTR optional
    szObjectName: cstring,  # LPCSTR
    mszCounterList: ptr char,  # LPSTR optional, out
    pcchCounterListLength: ptr uint32,  # DWORD* in/out
    mszInstanceList: ptr char,  # LPSTR optional, out
    pcchInstanceListLength: ptr uint32,  # DWORD* in/out
    dwDetailLevel: uint32,  # PERF_DETAIL
    dwFlags: uint32  # DWORD
): uint32 {.importc: "PdhEnumObjectItemsA", stdcall, dynlib: "pdh.dll".}

pragma(lib, "pdh");
extern(Windows)
uint PdhEnumObjectItemsA(
    const(char)* szDataSource,   // LPCSTR optional
    const(char)* szMachineName,   // LPCSTR optional
    const(char)* szObjectName,   // LPCSTR
    char* mszCounterList,   // LPSTR optional, out
    uint* pcchCounterListLength,   // DWORD* in/out
    char* mszInstanceList,   // LPSTR optional, out
    uint* pcchInstanceListLength,   // DWORD* in/out
    uint dwDetailLevel,   // PERF_DETAIL
    uint dwFlags   // DWORD
);

ccall((:PdhEnumObjectItemsA, "pdh.dll"), stdcall, UInt32,
      (Cstring, Cstring, Cstring, Ptr{UInt8}, Ptr{UInt32}, Ptr{UInt8}, Ptr{UInt32}, UInt32, UInt32),
      szDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags)
# szDataSource : LPCSTR optional -> Cstring
# szMachineName : LPCSTR optional -> Cstring
# szObjectName : LPCSTR -> Cstring
# mszCounterList : LPSTR optional, out -> Ptr{UInt8}
# pcchCounterListLength : DWORD* in/out -> Ptr{UInt32}
# mszInstanceList : LPSTR optional, out -> Ptr{UInt8}
# pcchInstanceListLength : DWORD* in/out -> Ptr{UInt32}
# dwDetailLevel : PERF_DETAIL -> UInt32
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

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

const koffi = require('koffi');
const lib = koffi.load('pdh.dll');
const PdhEnumObjectItemsA = lib.func('__stdcall', 'PdhEnumObjectItemsA', 'uint32_t', ['str', 'str', 'str', 'char *', 'uint32_t *', 'char *', 'uint32_t *', 'uint32_t', 'uint32_t']);
// PdhEnumObjectItemsA(szDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags)
// szDataSource : LPCSTR optional -> 'str'
// szMachineName : LPCSTR optional -> 'str'
// szObjectName : LPCSTR -> 'str'
// mszCounterList : LPSTR optional, out -> 'char *'
// pcchCounterListLength : DWORD* in/out -> 'uint32_t *'
// mszInstanceList : LPSTR optional, out -> 'char *'
// 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", {
  PdhEnumObjectItemsA: { parameters: ["buffer", "buffer", "buffer", "buffer", "pointer", "buffer", "pointer", "u32", "u32"], result: "u32" },
});
// lib.symbols.PdhEnumObjectItemsA(szDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags)
// szDataSource : LPCSTR optional -> "buffer"
// szMachineName : LPCSTR optional -> "buffer"
// szObjectName : LPCSTR -> "buffer"
// mszCounterList : LPSTR optional, out -> "buffer"
// pcchCounterListLength : DWORD* in/out -> "pointer"
// mszInstanceList : LPSTR optional, out -> "buffer"
// pcchInstanceListLength : DWORD* in/out -> "pointer"
// dwDetailLevel : PERF_DETAIL -> "u32"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
uint32_t PdhEnumObjectItemsA(
    const char* szDataSource,
    const char* szMachineName,
    const char* szObjectName,
    char* mszCounterList,
    uint32_t* pcchCounterListLength,
    char* mszInstanceList,
    uint32_t* pcchInstanceListLength,
    uint32_t dwDetailLevel,
    uint32_t dwFlags);
C, "pdh.dll");
// $ffi->PdhEnumObjectItemsA(szDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags);
// szDataSource : LPCSTR optional
// szMachineName : LPCSTR optional
// szObjectName : LPCSTR
// mszCounterList : LPSTR optional, out
// pcchCounterListLength : DWORD* in/out
// mszInstanceList : LPSTR 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.ASCII_OPTIONS);
    int PdhEnumObjectItemsA(
        String szDataSource,   // LPCSTR optional
        String szMachineName,   // LPCSTR optional
        String szObjectName,   // LPCSTR
        byte[] mszCounterList,   // LPSTR optional, out
        IntByReference pcchCounterListLength,   // DWORD* in/out
        byte[] mszInstanceList,   // LPSTR optional, out
        IntByReference pcchInstanceListLength,   // DWORD* in/out
        int dwDetailLevel,   // PERF_DETAIL
        int dwFlags   // DWORD
    );
}

@[Link("pdh")]
lib Libpdh
  fun PdhEnumObjectItemsA = PdhEnumObjectItemsA(
    szDataSource : UInt8*,   # LPCSTR optional
    szMachineName : UInt8*,   # LPCSTR optional
    szObjectName : UInt8*,   # LPCSTR
    mszCounterList : UInt8*,   # LPSTR optional, out
    pcchCounterListLength : UInt32*,   # DWORD* in/out
    mszInstanceList : UInt8*,   # LPSTR 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 PdhEnumObjectItemsANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>, Pointer<Utf8>, Pointer<Uint32>, Uint32, Uint32);
typedef PdhEnumObjectItemsADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>, Pointer<Utf8>, Pointer<Uint32>, int, int);
final PdhEnumObjectItemsA = DynamicLibrary.open('pdh.dll')
    .lookupFunction<PdhEnumObjectItemsANative, PdhEnumObjectItemsADart>('PdhEnumObjectItemsA');
// szDataSource : LPCSTR optional -> Pointer<Utf8>
// szMachineName : LPCSTR optional -> Pointer<Utf8>
// szObjectName : LPCSTR -> Pointer<Utf8>
// mszCounterList : LPSTR optional, out -> Pointer<Utf8>
// pcchCounterListLength : DWORD* in/out -> Pointer<Uint32>
// mszInstanceList : LPSTR optional, out -> Pointer<Utf8>
// pcchInstanceListLength : DWORD* in/out -> Pointer<Uint32>
// dwDetailLevel : PERF_DETAIL -> Uint32
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

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

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

foreign import stdcall safe "PdhEnumObjectItemsA"
  c_PdhEnumObjectItemsA :: CString -> CString -> CString -> CString -> Ptr Word32 -> CString -> Ptr Word32 -> Word32 -> Word32 -> IO Word32
-- szDataSource : LPCSTR optional -> CString
-- szMachineName : LPCSTR optional -> CString
-- szObjectName : LPCSTR -> CString
-- mszCounterList : LPSTR optional, out -> CString
-- pcchCounterListLength : DWORD* in/out -> Ptr Word32
-- mszInstanceList : LPSTR optional, out -> CString
-- 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 pdhenumobjectitemsa =
  foreign "PdhEnumObjectItemsA"
    (string @-> string @-> string @-> string @-> (ptr uint32_t) @-> string @-> (ptr uint32_t) @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* szDataSource : LPCSTR optional -> string *)
(* szMachineName : LPCSTR optional -> string *)
(* szObjectName : LPCSTR -> string *)
(* mszCounterList : LPSTR optional, out -> string *)
(* pcchCounterListLength : DWORD* in/out -> (ptr uint32_t) *)
(* mszInstanceList : LPSTR optional, out -> string *)
(* 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 ("PdhEnumObjectItemsA" pdh-enum-object-items-a :convention :stdcall) :uint32
  (sz-data-source :string)   ; LPCSTR optional
  (sz-machine-name :string)   ; LPCSTR optional
  (sz-object-name :string)   ; LPCSTR
  (msz-counter-list :pointer)   ; LPSTR optional, out
  (pcch-counter-list-length :pointer)   ; DWORD* in/out
  (msz-instance-list :pointer)   ; LPSTR 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 $PdhEnumObjectItemsA = Win32::API::More->new('pdh',
    'DWORD PdhEnumObjectItemsA(LPCSTR szDataSource, LPCSTR szMachineName, LPCSTR szObjectName, LPSTR mszCounterList, LPVOID pcchCounterListLength, LPSTR mszInstanceList, LPVOID pcchInstanceListLength, DWORD dwDetailLevel, DWORD dwFlags)');
# my $ret = $PdhEnumObjectItemsA->Call($szDataSource, $szMachineName, $szObjectName, $mszCounterList, $pcchCounterListLength, $mszInstanceList, $pcchInstanceListLength, $dwDetailLevel, $dwFlags);
# szDataSource : LPCSTR optional -> LPCSTR
# szMachineName : LPCSTR optional -> LPCSTR
# szObjectName : LPCSTR -> LPCSTR
# mszCounterList : LPSTR optional, out -> LPSTR
# pcchCounterListLength : DWORD* in/out -> LPVOID
# mszInstanceList : LPSTR optional, out -> LPSTR
# pcchInstanceListLength : DWORD* in/out -> LPVOID
# dwDetailLevel : PERF_DETAIL -> DWORD
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

PdhEnumObjectItemsA

シグネチャ

パラメーター

公式ドキュメント

戻り値

解説(Remarks)

Examples

各言語での呼び出し定義

関連項目