ホーム › System.Performance › PdhEnumObjectItemsHW

PdhEnumObjectItemsHW

関数

ハンドル指定でカウンターとインスタンスを列挙する。

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

シグネチャ

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

DWORD PdhEnumObjectItemsHW(
    PDH_HLOG hDataSource,   // optional
    LPCWSTR szMachineName,   // optional
    LPCWSTR szObjectName,
    LPWSTR mszCounterList,   // optional
    DWORD* pcchCounterListLength,
    LPWSTR mszInstanceList,   // optional
    DWORD* pcchInstanceListLength,
    PERF_DETAIL dwDetailLevel,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

hDataSource

PDH_HLOG

inoptional

PdhBindInputDataSource 関数によって返されたデータソースへのハンドル。

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

公式ドキュメント

指定したコンピューター上または指定したログファイル内に存在する、指定オブジェクトのカウンター名とインスタンス名を返します。この関数は PdhEnumObjectItems 関数と同一ですが、データソースへのハンドルの使用をサポートしている点が異なります。(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 回目はデータを取得するためです。

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

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PdhEnumObjectItemsHW(
    PDH_HLOG hDataSource,   // 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 PdhEnumObjectItemsHW(
    IntPtr hDataSource,   // PDH_HLOG 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 PdhEnumObjectItemsHW(
    hDataSource As IntPtr,   ' PDH_HLOG 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

' hDataSource : PDH_HLOG 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 PdhEnumObjectItemsHW Lib "pdh" ( _
    ByVal hDataSource 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

PdhEnumObjectItemsHW = ctypes.windll.pdh.PdhEnumObjectItemsHW
PdhEnumObjectItemsHW.restype = wintypes.DWORD
PdhEnumObjectItemsHW.argtypes = [
    wintypes.HANDLE,  # hDataSource : PDH_HLOG 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')
PdhEnumObjectItemsHW = Fiddle::Function.new(
  lib['PdhEnumObjectItemsHW'],
  [
    Fiddle::TYPE_VOIDP,  # hDataSource : PDH_HLOG 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 PdhEnumObjectItemsHW(
        hDataSource: *mut core::ffi::c_void,  // PDH_HLOG 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 PdhEnumObjectItemsHW(IntPtr hDataSource, [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_PdhEnumObjectItemsHW' -Namespace Win32 -PassThru
# $api::PdhEnumObjectItemsHW(hDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags)

#uselib "pdh.dll"
#func global PdhEnumObjectItemsHW "PdhEnumObjectItemsHW" wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr
; PdhEnumObjectItemsHW hDataSource, szMachineName, szObjectName, varptr(mszCounterList), varptr(pcchCounterListLength), varptr(mszInstanceList), varptr(pcchInstanceListLength), dwDetailLevel, dwFlags   ; 戻り値は stat
; hDataSource : PDH_HLOG 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 PdhEnumObjectItemsHW "PdhEnumObjectItemsHW" sptr, wstr, wstr, var, var, var, var, int, int
; res = PdhEnumObjectItemsHW(hDataSource, szMachineName, szObjectName, mszCounterList, pcchCounterListLength, mszInstanceList, pcchInstanceListLength, dwDetailLevel, dwFlags)
; hDataSource : PDH_HLOG optional -> "sptr"
; 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 PdhEnumObjectItemsHW "PdhEnumObjectItemsHW" sptr, wstr, wstr, sptr, sptr, sptr, sptr, int, int
; res = PdhEnumObjectItemsHW(hDataSource, szMachineName, szObjectName, varptr(mszCounterList), varptr(pcchCounterListLength), varptr(mszInstanceList), varptr(pcchInstanceListLength), dwDetailLevel, dwFlags)
; hDataSource : PDH_HLOG optional -> "sptr"
; 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(変数))。