ホーム › System.Performance › PdhEnumObjectItemsHA

PdhEnumObjectItemsHA

関数

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

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

シグネチャ

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

DWORD PdhEnumObjectItemsHA(
    PDH_HLOG hDataSource,   // optional
    LPCSTR szMachineName,   // optional
    LPCSTR szObjectName,
    LPSTR mszCounterList,   // optional
    DWORD* pcchCounterListLength,
    LPSTR mszInstanceList,   // optional
    DWORD* pcchInstanceListLength,
    PERF_DETAIL dwDetailLevel,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

hDataSource

PDH_HLOG

inoptional

PdhBindInputDataSource 関数が返すデータソースへのハンドル。

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 になります。指定オブジェクトが可変インスタンスをサポートするものの現在インスタンスが存在しない場合、返される値は 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 関数と同一です。(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 回目はデータを取得するためです。

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

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

メモ

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

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

' hDataSource : PDH_HLOG 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 PdhEnumObjectItemsHA Lib "pdh" ( _
    ByVal hDataSource As LongPtr, _
    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

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

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