ホーム › System.Performance › PdhEnumMachinesA

PdhEnumMachinesA

関数

データソース内のマシン名一覧を列挙する(ANSI版)。

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

シグネチャ

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

DWORD PdhEnumMachinesA(
    LPCSTR szDataSource,   // optional
    LPSTR mszMachineList,   // optional
    DWORD* pcchBufferSize
);

パラメーター

名前	型	方向	説明
szDataSource	LPCSTR	inoptional	ログファイルの名前を指定する null 終端文字列です。この関数は、カウンターデータがログファイルに格納されているコンピューターの名前を列挙します。NULL の場合、リアルタイムクエリにカウンターを追加したとき、または PdhConnectMachine 関数を呼び出したときに指定されたコンピューターの一覧を列挙します。
mszMachineList	LPSTR	outoptional	コンピューター名を格納する null 終端文字列の一覧を受け取る、呼び出し側が割り当てたバッファーです。この一覧は 2 つの null 終端文字で終わります。pcchBufferLength が 0 の場合は NULL を設定します。
pcchBufferSize	DWORD*	inout	mszMachineNameList バッファーのサイズ(TCHAR 単位)です。入力時に 0 の場合、関数は PDH_MORE_DATA を返し、このパラメーターに必要なバッファーサイズを設定します。バッファーが必要なサイズより大きい場合、関数はこのパラメーターに実際に使用されたバッファーのサイズを設定します。入力時に指定したサイズが 0 より大きいものの必要なサイズより小さい場合、返されたサイズを基にバッファーを再割り当てしないでください。

戻り値の型: DWORD

公式ドキュメント

ログファイル内のカウンターに関連付けられたコンピューター名の一覧を返します。(PdhEnumMachinesA)

戻り値

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

関数が失敗した場合、戻り値はシステムエラーコードまたは PDH エラーコードです。次の値が考えられます。

戻り値	説明
PDH_MORE_DATA	mszMachineNameList バッファーが小さすぎて、すべてのデータを格納できません。この戻り値は、入力時に pcchBufferLength が 0 の場合に想定される値です。入力時に指定したサイズが 0 より大きいものの必要なサイズより小さい場合、返されたサイズを基にバッファーを再割り当てしないでください。
PDH_INVALID_ARGUMENT	パラメーターが無効です。たとえば、一部のリリースでは、入力時に指定したサイズが 0 より大きいものの必要なサイズより小さい場合にこのエラーが返されることがあります。

解説(Remarks)

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PdhEnumMachinesA(
    LPCSTR szDataSource,   // optional
    LPSTR mszMachineList,   // optional
    DWORD* pcchBufferSize
);

[DllImport("pdh.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint PdhEnumMachinesA(
    [MarshalAs(UnmanagedType.LPStr)] string szDataSource,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder mszMachineList,   // LPSTR optional, out
    ref uint pcchBufferSize   // DWORD* in/out
);

<DllImport("pdh.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PdhEnumMachinesA(
    <MarshalAs(UnmanagedType.LPStr)> szDataSource As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> mszMachineList As System.Text.StringBuilder,   ' LPSTR optional, out
    ByRef pcchBufferSize As UInteger   ' DWORD* in/out
) As UInteger
End Function

' szDataSource : LPCSTR optional
' mszMachineList : LPSTR optional, out
' pcchBufferSize : DWORD* in/out
Declare PtrSafe Function PdhEnumMachinesA Lib "pdh" ( _
    ByVal szDataSource As String, _
    ByVal mszMachineList As String, _
    ByRef pcchBufferSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhEnumMachinesA = ctypes.windll.pdh.PdhEnumMachinesA
PdhEnumMachinesA.restype = wintypes.DWORD
PdhEnumMachinesA.argtypes = [
    wintypes.LPCSTR,  # szDataSource : LPCSTR optional
    wintypes.LPSTR,  # mszMachineList : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchBufferSize : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhEnumMachinesA = Fiddle::Function.new(
  lib['PdhEnumMachinesA'],
  [
    Fiddle::TYPE_VOIDP,  # szDataSource : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # mszMachineList : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchBufferSize : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhEnumMachinesA(
        szDataSource: *const u8,  // LPCSTR optional
        mszMachineList: *mut u8,  // LPSTR optional, out
        pcchBufferSize: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("pdh.dll", CharSet = CharSet.Ansi)]
public static extern uint PdhEnumMachinesA([MarshalAs(UnmanagedType.LPStr)] string szDataSource, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder mszMachineList, ref uint pcchBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhEnumMachinesA' -Namespace Win32 -PassThru
# $api::PdhEnumMachinesA(szDataSource, mszMachineList, pcchBufferSize)

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

出力引数:

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