ホーム › System.Performance › PdhExpandWildCardPathHW

PdhExpandWildCardPathHW

関数

ハンドル指定でワイルドカードパスを展開する。

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

シグネチャ

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

DWORD PdhExpandWildCardPathHW(
    PDH_HLOG hDataSource,   // optional
    LPCWSTR szWildCardPath,
    LPWSTR mszExpandedPathList,   // optional
    DWORD* pcchPathListLength,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

hDataSource

PDH_HLOG

inoptional

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

szWildCardPath

LPCWSTR

展開するカウンターパスを指定する Null 終端文字列です。カウンターパスの最大長は PDH_MAX_COUNTER_PATH です。

hDataSource がリアルタイムのデータソースである場合、この関数はパスで指定されたコンピューターを検索して一致を探します。パスにコンピューターが指定されていない場合は、ローカルコンピューターを検索します。

mszExpandedPathList

LPWSTR

outoptional

szWildCardPath のワイルドカード指定に一致する null 終端カウンターパスのリストを受け取る、呼び出し側が割り当てたバッファーです。リストは 2 つの NULL 文字で終端されます。pcchPathListLength がゼロの場合は NULL に設定します。

pcchPathListLength

DWORD*

inout

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

注意 Windows XP では、必要なサイズに 1 を加算する必要があります。

dwFlags

DWORD

展開しないワイルドカード文字を示すフラグです。1 つ以上のフラグを指定できます。

値	意味
PDH_NOEXPANDCOUNTERS	パスにカウンター名のワイルドカード文字が含まれていても、カウンター名を展開しません。
PDH_NOEXPANDINSTANCES	パスに親インスタンス、インスタンス名、またはインスタンスインデックスのワイルドカード文字が含まれていても、インスタンス名を展開しません。
PDH_REFRESHCOUNTERS	カウンターリストを更新します。

戻り値の型: DWORD

公式ドキュメント

指定したコンピューターまたはログファイルを調べ、ワイルドカード文字を含む指定のカウンターパスに一致するカウンターパスを返します。この関数は、データソースへのハンドルの使用をサポートする点を除いて、PdhExpandWildCardPath 関数と同一です。(Unicode)

戻り値

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

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

戻り値	説明
PDH_MORE_DATA	mszExpandedPathList バッファーがパスのリストを格納するのに十分な大きさではありません。この戻り値は、入力時に pcchPathListLength がゼロの場合に想定されるものです。入力時に指定したサイズがゼロより大きく必要なサイズより小さい場合、返されたサイズを基にバッファーを再割り当てしないでください。
PDH_INVALID_ARGUMENT	パラメーターが無効です。たとえば、一部のリリースでは、入力時に指定したサイズがゼロより大きく必要なサイズより小さい場合にこのエラーを受け取ることがあります。
PDH_MEMORY_ALLOCATION_FAILURE	この関数をサポートするためのメモリを割り当てることができません。
PDH_CSTATUS_NO_OBJECT	コンピューターまたはログファイル内で指定されたオブジェクトを見つけることができません。

解説(Remarks)

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

PdhExpandWildCardPathH は、次の点で PdhExpandCounterPath と異なります。

展開するワイルドカード文字を制御できます。
ログファイルの内容をカウンター名のソースとして使用できます。

一般的なカウンターパスの形式は次のとおりです。

\computer\object(parent/instance#index)\counter

カウンターパスの parent、instance、index、counter の各コンポーネントには、有効な名前またはワイルドカード文字のいずれかを含めることができます。computer、parent、instance、index の各コンポーネントは、すべてのカウンターで必要なわけではありません。

指定可能な形式の一覧は次のとおりです。

\\computer\object(parent/instance#index)\counter
\\computer\object(parent/instance)\counter
\\computer\object(instance#index)\counter
\\computer\object(instance)\counter
\\computer\object\counter
\object(parent/instance#index)\counter
\object(parent/instance)\counter
\object(instance#index)\counter
\object(instance)\counter
\object\counter

ワイルドカード文字としてアスタリスク(*)を使用します。たとえば、\object(*)\counter のようになります。

親名にワイルドカード文字が指定されている場合、指定された instance フィールドおよび counter フィールドに一致する、指定オブジェクトのすべてのインスタンスが返されます。たとえば、\object(*/instance)\counter のようになります。

インスタンス名にワイルドカード文字が指定されている場合、指定インデックスに対応するすべてのインスタンス名がワイルドカード文字に一致すれば、指定オブジェクトおよび親オブジェクトのすべてのインスタンスが返されます。たとえば、\object(parent/*)\counter のようになります。

カウンター名にワイルドカード文字が指定されている場合、指定オブジェクトのすべてのカウンターが返されます。

カウンターパス文字列の部分一致(たとえば "pro*")がサポートされます。

Windows Vista より前: 部分的なワイルドカード一致はサポートされていません。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PdhExpandWildCardPathHW(
    PDH_HLOG hDataSource,   // optional
    LPCWSTR szWildCardPath,
    LPWSTR mszExpandedPathList,   // optional
    DWORD* pcchPathListLength,
    DWORD dwFlags
);

[DllImport("pdh.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PdhExpandWildCardPathHW(
    IntPtr hDataSource,   // PDH_HLOG optional
    [MarshalAs(UnmanagedType.LPWStr)] string szWildCardPath,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszExpandedPathList,   // LPWSTR optional, out
    ref uint pcchPathListLength,   // DWORD* in/out
    uint dwFlags   // DWORD
);

<DllImport("pdh.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PdhExpandWildCardPathHW(
    hDataSource As IntPtr,   ' PDH_HLOG optional
    <MarshalAs(UnmanagedType.LPWStr)> szWildCardPath As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> mszExpandedPathList As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcchPathListLength As UInteger,   ' DWORD* in/out
    dwFlags As UInteger   ' DWORD
) As UInteger
End Function

' hDataSource : PDH_HLOG optional
' szWildCardPath : LPCWSTR
' mszExpandedPathList : LPWSTR optional, out
' pcchPathListLength : DWORD* in/out
' dwFlags : DWORD
Declare PtrSafe Function PdhExpandWildCardPathHW Lib "pdh" ( _
    ByVal hDataSource As LongPtr, _
    ByVal szWildCardPath As LongPtr, _
    ByVal mszExpandedPathList As LongPtr, _
    ByRef pcchPathListLength As Long, _
    ByVal dwFlags 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

PdhExpandWildCardPathHW = ctypes.windll.pdh.PdhExpandWildCardPathHW
PdhExpandWildCardPathHW.restype = wintypes.DWORD
PdhExpandWildCardPathHW.argtypes = [
    wintypes.HANDLE,  # hDataSource : PDH_HLOG optional
    wintypes.LPCWSTR,  # szWildCardPath : LPCWSTR
    wintypes.LPWSTR,  # mszExpandedPathList : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchPathListLength : DWORD* in/out
    wintypes.DWORD,  # dwFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhExpandWildCardPathHW = Fiddle::Function.new(
  lib['PdhExpandWildCardPathHW'],
  [
    Fiddle::TYPE_VOIDP,  # hDataSource : PDH_HLOG optional
    Fiddle::TYPE_VOIDP,  # szWildCardPath : LPCWSTR
    Fiddle::TYPE_VOIDP,  # mszExpandedPathList : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchPathListLength : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "pdh")]
extern "system" {
    fn PdhExpandWildCardPathHW(
        hDataSource: *mut core::ffi::c_void,  // PDH_HLOG optional
        szWildCardPath: *const u16,  // LPCWSTR
        mszExpandedPathList: *mut u16,  // LPWSTR optional, out
        pcchPathListLength: *mut u32,  // DWORD* in/out
        dwFlags: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("pdh.dll", CharSet = CharSet.Unicode)]
public static extern uint PdhExpandWildCardPathHW(IntPtr hDataSource, [MarshalAs(UnmanagedType.LPWStr)] string szWildCardPath, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszExpandedPathList, ref uint pcchPathListLength, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhExpandWildCardPathHW' -Namespace Win32 -PassThru
# $api::PdhExpandWildCardPathHW(hDataSource, szWildCardPath, mszExpandedPathList, pcchPathListLength, dwFlags)

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

出力引数:

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