ホーム › System.Performance › PdhExpandWildCardPathW

PdhExpandWildCardPathW

関数

データソース指定でワイルドカードパスを完全パスに展開する。

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

シグネチャ

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

DWORD PdhExpandWildCardPathW(
    LPCWSTR szDataSource,   // optional
    LPCWSTR szWildCardPath,
    LPWSTR mszExpandedPathList,   // optional
    DWORD* pcchPathListLength,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

szDataSource

LPCWSTR

inoptional

ログファイルの名前を格納したnull終端文字列です。この関数は、ログファイル内で定義されているパフォーマンスオブジェクトおよびカウンターを使用して、szWildCardPath パラメーターで指定されたパスを展開します。

NULL の場合、この関数は szWildCardPath で指定されたコンピューターを検索します。

szWildCardPath

LPCWSTR

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

szDataSource パラメーターが NULL の場合、この関数はパスで指定されたコンピューターを検索して一致を探します。パスにコンピューターが指定されていない場合は、ローカルコンピューターを検索します。

mszExpandedPathList

LPWSTR

outoptional

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

pcchPathListLength

DWORD*

inout

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

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

dwFlags

DWORD

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

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

戻り値の型: DWORD

公式ドキュメント

指定されたコンピューターまたはログファイルを調べ、ワイルドカード文字を含む指定されたカウンターパスに一致するカウンターパスを返します。データソースへのハンドルを使用するには、PdhExpandWildCardPathH 関数を使用してください。(Unicode)

戻り値

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

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

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

解説(Remarks)

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

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

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

[DllImport("pdh.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PdhExpandWildCardPathW(
    [MarshalAs(UnmanagedType.LPWStr)] string szDataSource,   // LPCWSTR 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 PdhExpandWildCardPathW(
    <MarshalAs(UnmanagedType.LPWStr)> szDataSource As String,   ' LPCWSTR 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

' szDataSource : LPCWSTR optional
' szWildCardPath : LPCWSTR
' mszExpandedPathList : LPWSTR optional, out
' pcchPathListLength : DWORD* in/out
' dwFlags : DWORD
Declare PtrSafe Function PdhExpandWildCardPathW Lib "pdh" ( _
    ByVal szDataSource 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

PdhExpandWildCardPathW = ctypes.windll.pdh.PdhExpandWildCardPathW
PdhExpandWildCardPathW.restype = wintypes.DWORD
PdhExpandWildCardPathW.argtypes = [
    wintypes.LPCWSTR,  # szDataSource : LPCWSTR 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')
PdhExpandWildCardPathW = Fiddle::Function.new(
  lib['PdhExpandWildCardPathW'],
  [
    Fiddle::TYPE_VOIDP,  # szDataSource : LPCWSTR 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 PdhExpandWildCardPathW(
        szDataSource: *const u16,  // LPCWSTR 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 PdhExpandWildCardPathW([MarshalAs(UnmanagedType.LPWStr)] string szDataSource, [MarshalAs(UnmanagedType.LPWStr)] string szWildCardPath, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszExpandedPathList, ref uint pcchPathListLength, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhExpandWildCardPathW' -Namespace Win32 -PassThru
# $api::PdhExpandWildCardPathW(szDataSource, szWildCardPath, mszExpandedPathList, pcchPathListLength, dwFlags)

#uselib "pdh.dll"
#func global PdhExpandWildCardPathW "PdhExpandWildCardPathW" wptr, wptr, wptr, wptr, wptr
; PdhExpandWildCardPathW szDataSource, szWildCardPath, varptr(mszExpandedPathList), varptr(pcchPathListLength), dwFlags   ; 戻り値は stat
; szDataSource : LPCWSTR 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 PdhExpandWildCardPathW "PdhExpandWildCardPathW" wstr, wstr, var, var, int
; res = PdhExpandWildCardPathW(szDataSource, szWildCardPath, mszExpandedPathList, pcchPathListLength, dwFlags)
; szDataSource : LPCWSTR optional -> "wstr"
; szWildCardPath : LPCWSTR -> "wstr"
; mszExpandedPathList : LPWSTR optional, out -> "var"
; pcchPathListLength : DWORD* in/out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "pdh.dll"
#cfunc global PdhExpandWildCardPathW "PdhExpandWildCardPathW" wstr, wstr, sptr, sptr, int
; res = PdhExpandWildCardPathW(szDataSource, szWildCardPath, varptr(mszExpandedPathList), varptr(pcchPathListLength), dwFlags)
; szDataSource : LPCWSTR optional -> "wstr"
; szWildCardPath : LPCWSTR -> "wstr"
; mszExpandedPathList : LPWSTR optional, out -> "sptr"
; pcchPathListLength : DWORD* in/out -> "sptr"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。