ホーム › System.Performance › PdhEnumObjectsW

PdhEnumObjectsW

関数

マシン上のパフォーマンスオブジェクト一覧を列挙する。

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

シグネチャ

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

DWORD PdhEnumObjectsW(
    LPCWSTR szDataSource,   // optional
    LPCWSTR szMachineName,   // optional
    LPWSTR mszObjectList,   // optional
    DWORD* pcchBufferSize,
    PERF_DETAIL dwDetailLevel,
    BOOL bRefresh
);

パラメーター

名前

型

方向

説明

szDataSource

LPCWSTR

inoptional

パフォーマンスオブジェクトの列挙に使用するログファイルの名前を指定する null 終端文字列です。NULL の場合、関数は szMachineName パラメーターで指定したコンピューターを使用して名前を列挙します。

szMachineName

LPCWSTR

inoptional

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

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

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

mszObjectList

LPWSTR

outoptional

オブジェクト名の一覧を受け取る、呼び出し元が確保したバッファーです。この一覧の各オブジェクト名は null 文字で終端されます。一覧全体は 2 つの null 終端文字で終端されます。pcchBufferLength パラメーターが 0 の場合は NULL を設定します。

pcchBufferSize

DWORD*

inout

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

Windows XP: 必要なバッファーサイズに 1 を加えてください。

dwDetailLevel

PERF_DETAIL

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

Value	Meaning
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 が返ることがあります。

Value	Meaning
TRUE	オブジェクトを返す前にオブジェクトキャッシュを自動的に更新します。
FALSE	キャッシュを自動的に更新しません。

戻り値の型: DWORD

公式ドキュメント

指定したコンピューターまたは指定したログファイルで利用可能なオブジェクトの一覧を返します。データソースへのハンドルを使用するには、PdhEnumObjectsH 関数を使用します。(Unicode)

戻り値

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

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

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

解説(Remarks)

この関数は 2 回呼び出してください。1 回目は必要なバッファーサイズを取得するため（mszObjectList を NULL に、pcchBufferLength を 0 に設定）、2 回目はデータを取得するためです。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PdhEnumObjectsW(
    LPCWSTR szDataSource,   // 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 PdhEnumObjectsW(
    [MarshalAs(UnmanagedType.LPWStr)] string szDataSource,   // LPCWSTR 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 PdhEnumObjectsW(
    <MarshalAs(UnmanagedType.LPWStr)> szDataSource As String,   ' LPCWSTR 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

' szDataSource : LPCWSTR optional
' szMachineName : LPCWSTR optional
' mszObjectList : LPWSTR optional, out
' pcchBufferSize : DWORD* in/out
' dwDetailLevel : PERF_DETAIL
' bRefresh : BOOL
Declare PtrSafe Function PdhEnumObjectsW Lib "pdh" ( _
    ByVal szDataSource 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

PdhEnumObjectsW = ctypes.windll.pdh.PdhEnumObjectsW
PdhEnumObjectsW.restype = wintypes.DWORD
PdhEnumObjectsW.argtypes = [
    wintypes.LPCWSTR,  # szDataSource : LPCWSTR 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')
PdhEnumObjectsW = Fiddle::Function.new(
  lib['PdhEnumObjectsW'],
  [
    Fiddle::TYPE_VOIDP,  # szDataSource : LPCWSTR 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 PdhEnumObjectsW(
        szDataSource: *const u16,  // LPCWSTR 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 PdhEnumObjectsW([MarshalAs(UnmanagedType.LPWStr)] string szDataSource, [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_PdhEnumObjectsW' -Namespace Win32 -PassThru
# $api::PdhEnumObjectsW(szDataSource, szMachineName, mszObjectList, pcchBufferSize, dwDetailLevel, bRefresh)

#uselib "pdh.dll"
#func global PdhEnumObjectsW "PdhEnumObjectsW" wptr, wptr, wptr, wptr, wptr, wptr
; PdhEnumObjectsW szDataSource, szMachineName, varptr(mszObjectList), varptr(pcchBufferSize), dwDetailLevel, bRefresh   ; 戻り値は stat
; szDataSource : LPCWSTR 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 PdhEnumObjectsW "PdhEnumObjectsW" wstr, wstr, var, var, int, int
; res = PdhEnumObjectsW(szDataSource, szMachineName, mszObjectList, pcchBufferSize, dwDetailLevel, bRefresh)
; szDataSource : LPCWSTR optional -> "wstr"
; 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 PdhEnumObjectsW "PdhEnumObjectsW" wstr, wstr, sptr, sptr, int, int
; res = PdhEnumObjectsW(szDataSource, szMachineName, varptr(mszObjectList), varptr(pcchBufferSize), dwDetailLevel, bRefresh)
; szDataSource : LPCWSTR optional -> "wstr"
; szMachineName : LPCWSTR optional -> "wstr"
; mszObjectList : LPWSTR optional, out -> "sptr"
; pcchBufferSize : DWORD* in/out -> "sptr"
; dwDetailLevel : PERF_DETAIL -> "int"
; bRefresh : BOOL -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。