ホーム › System.Performance › PdhEnumObjectsHW

PdhEnumObjectsHW

関数

データソースハンドルからオブジェクト一覧を列挙する。

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

シグネチャ

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

DWORD PdhEnumObjectsHW(
    PDH_HLOG hDataSource,   // optional
    LPCWSTR szMachineName,   // optional
    LPWSTR mszObjectList,   // optional
    DWORD* pcchBufferSize,
    PERF_DETAIL dwDetailLevel,
    BOOL bRefresh
);

パラメーター

名前

型

方向

説明

hDataSource

PDH_HLOG

inoptional

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

szMachineName

LPCWSTR

inoptional

パフォーマンスオブジェクトを列挙するために使用するコンピューターの名前を指定する Null 終端文字列です。

コンピューター名には先頭のスラッシュを含めます。例: \computername。

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

mszObjectList

LPWSTR

outoptional

オブジェクト名の一覧を受け取る、呼び出し元が割り当てたバッファーです。この一覧内の各オブジェクト名は null 文字で終端されます。一覧全体は 2 つの null 終端文字で終端されます。pcchBufferLength がゼロの場合は NULL に設定します。

pcchBufferSize

DWORD*

inout

mszObjectList バッファーのサイズ(TCHAR 単位)です。入力時にゼロの場合、関数は PDH_MORE_DATA を返し、このパラメーターに必要なバッファーサイズを設定します。バッファーが必要なサイズより大きい場合、関数はこのパラメーターに実際に使用されたバッファーのサイズを設定します。入力時に指定されたサイズがゼロより大きく、かつ必要なサイズより小さい場合、返されたサイズを使ってバッファーを再割り当てしないでください。

Windows XP: 必要なバッファーサイズに 1 を加算します。

dwDetailLevel

PERF_DETAIL

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

値	意味
PERF_DETAIL_NOVICE	初心者ユーザーレベルの詳細。
PERF_DETAIL_ADVANCED	上級ユーザーレベルの詳細。
PERF_DETAIL_EXPERT	エキスパートユーザーレベルの詳細。
PERF_DETAIL_WIZARD	システム設計者レベルの詳細。

bRefresh

BOOL

キャッシュされたオブジェクト一覧を自動的に更新するかどうかを示します。次のいずれかの値を指定します。

この関数を 2 回呼び出す場合(1 回目で一覧のサイズを取得し、2 回目で実際の一覧を取得する場合)、このパラメーターを 1 回目の呼び出しでは TRUE に、2 回目の呼び出しでは FALSE に設定します。両方の呼び出しを TRUE にすると、呼び出しの間にオブジェクトデータが変化する可能性があるため、2 回目の呼び出しでも PDH_MORE_DATA が返される場合があります。

値	意味
TRUE	オブジェクトを返す前に、オブジェクトキャッシュが自動的に更新されます。
FALSE	キャッシュを自動的に更新しません。

戻り値の型: DWORD

公式ドキュメント

指定されたコンピューターまたは指定されたログファイルで利用可能なオブジェクトの一覧を返します。この関数は PdhEnumObjects と同一ですが、データソースへのハンドルの使用をサポートする点が異なります。(Unicode)

戻り値

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

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

戻り値	説明
PDH_MORE_DATA	mszObjectList バッファーがオブジェクトの一覧を保持するには小さすぎます。入力時に pcchBufferLength がゼロの場合、この戻り値が返されることが想定されます。入力時に指定されたサイズがゼロより大きく、かつ必要なサイズより小さい場合、返されたサイズを使ってバッファーを再割り当てしないでください。
PDH_CSTATUS_NO_MACHINE	指定されたコンピューターがオフラインであるか、利用できません。
PDH_CSTATUS_NO_OBJECT	指定されたオブジェクトが見つかりませんでした。
PDH_INVALID_ARGUMENT	パラメーターが無効です。例えば、一部のリリースでは、入力時に指定されたサイズがゼロより大きく、かつ必要なサイズより小さい場合にこのエラーが返されることがあります。

解説(Remarks)

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PdhEnumObjectsHW(
    PDH_HLOG hDataSource,   // optional
    LPCWSTR szMachineName,   // optional
    LPWSTR mszObjectList,   // optional
    DWORD* pcchBufferSize,
    PERF_DETAIL dwDetailLevel,
    BOOL bRefresh
);

[DllImport("pdh.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PdhEnumObjectsHW(
    IntPtr hDataSource,   // PDH_HLOG optional
    [MarshalAs(UnmanagedType.LPWStr)] string szMachineName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszObjectList,   // LPWSTR optional, out
    ref uint pcchBufferSize,   // DWORD* in/out
    uint dwDetailLevel,   // PERF_DETAIL
    bool bRefresh   // BOOL
);

<DllImport("pdh.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PdhEnumObjectsHW(
    hDataSource As IntPtr,   ' PDH_HLOG optional
    <MarshalAs(UnmanagedType.LPWStr)> szMachineName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> mszObjectList As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcchBufferSize As UInteger,   ' DWORD* in/out
    dwDetailLevel As UInteger,   ' PERF_DETAIL
    bRefresh As Boolean   ' BOOL
) As UInteger
End Function

' hDataSource : PDH_HLOG optional
' szMachineName : LPCWSTR optional
' mszObjectList : LPWSTR optional, out
' pcchBufferSize : DWORD* in/out
' dwDetailLevel : PERF_DETAIL
' bRefresh : BOOL
Declare PtrSafe Function PdhEnumObjectsHW Lib "pdh" ( _
    ByVal hDataSource As LongPtr, _
    ByVal szMachineName As LongPtr, _
    ByVal mszObjectList As LongPtr, _
    ByRef pcchBufferSize As Long, _
    ByVal dwDetailLevel As Long, _
    ByVal bRefresh 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

PdhEnumObjectsHW = ctypes.windll.pdh.PdhEnumObjectsHW
PdhEnumObjectsHW.restype = wintypes.DWORD
PdhEnumObjectsHW.argtypes = [
    wintypes.HANDLE,  # hDataSource : PDH_HLOG optional
    wintypes.LPCWSTR,  # szMachineName : LPCWSTR optional
    wintypes.LPWSTR,  # mszObjectList : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchBufferSize : DWORD* in/out
    wintypes.DWORD,  # dwDetailLevel : PERF_DETAIL
    wintypes.BOOL,  # bRefresh : BOOL
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhEnumObjectsHW = Fiddle::Function.new(
  lib['PdhEnumObjectsHW'],
  [
    Fiddle::TYPE_VOIDP,  # hDataSource : PDH_HLOG optional
    Fiddle::TYPE_VOIDP,  # szMachineName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # mszObjectList : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchBufferSize : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwDetailLevel : PERF_DETAIL
    Fiddle::TYPE_INT,  # bRefresh : BOOL
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "pdh")]
extern "system" {
    fn PdhEnumObjectsHW(
        hDataSource: *mut core::ffi::c_void,  // PDH_HLOG optional
        szMachineName: *const u16,  // LPCWSTR optional
        mszObjectList: *mut u16,  // LPWSTR optional, out
        pcchBufferSize: *mut u32,  // DWORD* in/out
        dwDetailLevel: u32,  // PERF_DETAIL
        bRefresh: i32  // BOOL
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("pdh.dll", CharSet = CharSet.Unicode)]
public static extern uint PdhEnumObjectsHW(IntPtr hDataSource, [MarshalAs(UnmanagedType.LPWStr)] string szMachineName, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszObjectList, ref uint pcchBufferSize, uint dwDetailLevel, bool bRefresh);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhEnumObjectsHW' -Namespace Win32 -PassThru
# $api::PdhEnumObjectsHW(hDataSource, szMachineName, mszObjectList, pcchBufferSize, dwDetailLevel, bRefresh)

#uselib "pdh.dll"
#func global PdhEnumObjectsHW "PdhEnumObjectsHW" wptr, wptr, wptr, wptr, wptr, wptr
; PdhEnumObjectsHW hDataSource, szMachineName, varptr(mszObjectList), varptr(pcchBufferSize), dwDetailLevel, bRefresh   ; 戻り値は stat
; hDataSource : PDH_HLOG optional -> "wptr"
; szMachineName : LPCWSTR optional -> "wptr"
; mszObjectList : LPWSTR optional, out -> "wptr"
; pcchBufferSize : DWORD* in/out -> "wptr"
; dwDetailLevel : PERF_DETAIL -> "wptr"
; bRefresh : BOOL -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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