ホーム › System.Performance › PdhEnumObjectsHA

PdhEnumObjectsHA

関数

ハンドル指定でオブジェクト一覧を列挙する(ANSI版)。

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

シグネチャ

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

DWORD PdhEnumObjectsHA(
    PDH_HLOG hDataSource,   // optional
    LPCSTR szMachineName,   // optional
    LPSTR mszObjectList,   // optional
    DWORD* pcchBufferSize,
    PERF_DETAIL dwDetailLevel,
    BOOL bRefresh
);

パラメーター

名前

型

方向

説明

hDataSource

PDH_HLOG

inoptional

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

szMachineName

LPCSTR

inoptional

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

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

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

mszObjectList

LPSTR

outoptional

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

pcchBufferSize

DWORD*

inout

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

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 と同一ですが、データソースへのハンドルの使用をサポートします。(ANSI)

戻り値

関数が成功すると、ERROR_SUCCESS を返します。

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

戻り値	説明
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 版を自動的に選択するエイリアスとして PdhEnumObjectsH を定義します。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在して使用すると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

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

<DllImport("pdh.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PdhEnumObjectsHA(
    hDataSource As IntPtr,   ' PDH_HLOG optional
    <MarshalAs(UnmanagedType.LPStr)> szMachineName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> mszObjectList As System.Text.StringBuilder,   ' LPSTR 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 : LPCSTR optional
' mszObjectList : LPSTR optional, out
' pcchBufferSize : DWORD* in/out
' dwDetailLevel : PERF_DETAIL
' bRefresh : BOOL
Declare PtrSafe Function PdhEnumObjectsHA Lib "pdh" ( _
    ByVal hDataSource As LongPtr, _
    ByVal szMachineName As String, _
    ByVal mszObjectList As String, _
    ByRef pcchBufferSize As Long, _
    ByVal dwDetailLevel As Long, _
    ByVal bRefresh As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhEnumObjectsHA = ctypes.windll.pdh.PdhEnumObjectsHA
PdhEnumObjectsHA.restype = wintypes.DWORD
PdhEnumObjectsHA.argtypes = [
    wintypes.HANDLE,  # hDataSource : PDH_HLOG optional
    wintypes.LPCSTR,  # szMachineName : LPCSTR optional
    wintypes.LPSTR,  # mszObjectList : LPSTR 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')
PdhEnumObjectsHA = Fiddle::Function.new(
  lib['PdhEnumObjectsHA'],
  [
    Fiddle::TYPE_VOIDP,  # hDataSource : PDH_HLOG optional
    Fiddle::TYPE_VOIDP,  # szMachineName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # mszObjectList : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchBufferSize : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwDetailLevel : PERF_DETAIL
    Fiddle::TYPE_INT,  # bRefresh : BOOL
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhEnumObjectsHA(
        hDataSource: *mut core::ffi::c_void,  // PDH_HLOG optional
        szMachineName: *const u8,  // LPCSTR optional
        mszObjectList: *mut u8,  // LPSTR 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.Ansi)]
public static extern uint PdhEnumObjectsHA(IntPtr hDataSource, [MarshalAs(UnmanagedType.LPStr)] string szMachineName, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder mszObjectList, ref uint pcchBufferSize, uint dwDetailLevel, bool bRefresh);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhEnumObjectsHA' -Namespace Win32 -PassThru
# $api::PdhEnumObjectsHA(hDataSource, szMachineName, mszObjectList, pcchBufferSize, dwDetailLevel, bRefresh)

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

出力引数:

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