ホーム › System.Performance › PdhEnumMachinesW

PdhEnumMachinesW

関数

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

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

シグネチャ

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

DWORD PdhEnumMachinesW(
    LPCWSTR szDataSource,   // optional
    LPWSTR mszMachineList,   // optional
    DWORD* pcchBufferSize
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

関数が失敗した場合、戻り値はシステムエラーコードまたは PDH エラーコードです。以下は想定される値です。

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

解説(Remarks)

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

メモ

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

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

[DllImport("pdh.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PdhEnumMachinesW(
    [MarshalAs(UnmanagedType.LPWStr)] string szDataSource,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszMachineList,   // LPWSTR optional, out
    ref uint pcchBufferSize   // DWORD* in/out
);

<DllImport("pdh.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PdhEnumMachinesW(
    <MarshalAs(UnmanagedType.LPWStr)> szDataSource As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> mszMachineList As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcchBufferSize As UInteger   ' DWORD* in/out
) As UInteger
End Function

' szDataSource : LPCWSTR optional
' mszMachineList : LPWSTR optional, out
' pcchBufferSize : DWORD* in/out
Declare PtrSafe Function PdhEnumMachinesW Lib "pdh" ( _
    ByVal szDataSource As LongPtr, _
    ByVal mszMachineList As LongPtr, _
    ByRef pcchBufferSize 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhEnumMachinesW = Fiddle::Function.new(
  lib['PdhEnumMachinesW'],
  [
    Fiddle::TYPE_VOIDP,  # szDataSource : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # mszMachineList : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchBufferSize : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "pdh")]
extern "system" {
    fn PdhEnumMachinesW(
        szDataSource: *const u16,  // LPCWSTR optional
        mszMachineList: *mut u16,  // LPWSTR 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.Unicode)]
public static extern uint PdhEnumMachinesW([MarshalAs(UnmanagedType.LPWStr)] string szDataSource, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszMachineList, ref uint pcchBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhEnumMachinesW' -Namespace Win32 -PassThru
# $api::PdhEnumMachinesW(szDataSource, mszMachineList, pcchBufferSize)

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

出力引数:

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