ホーム › System.Performance › PdhExpandWildCardPathA

PdhExpandWildCardPathA

関数

データソース指定でワイルドカードパスを展開する(ANSI版)。

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

シグネチャ

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

DWORD PdhExpandWildCardPathA(
    LPCSTR szDataSource,   // optional
    LPCSTR szWildCardPath,
    LPSTR mszExpandedPathList,   // optional
    DWORD* pcchPathListLength,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

szDataSource

LPCSTR

inoptional

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

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

szWildCardPath

LPCSTR

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

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

mszExpandedPathList

LPSTR

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

公式ドキュメント

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

戻り値

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

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

戻りコード	説明
PDH_MORE_DATA	mszExpandedPathList バッファーがパスのリストを格納するのに十分な大きさではありません。この戻り値は、入力時に pcchPathListLength がゼロの場合に想定される値です。入力時に指定したサイズがゼロより大きいが必要なサイズより小さい場合、返されたサイズをバッファーの再割り当てに使用しないでください。
PDH_INVALID_ARGUMENT	パラメーターが無効です。たとえば、一部のリリースでは、入力時に指定したサイズがゼロより大きいが必要なサイズより小さい場合に、このエラーが返されることがあります。
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  (ANSI / -A)
#include <windows.h>

DWORD PdhExpandWildCardPathA(
    LPCSTR szDataSource,   // optional
    LPCSTR szWildCardPath,
    LPSTR mszExpandedPathList,   // optional
    DWORD* pcchPathListLength,
    DWORD dwFlags
);

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

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

' szDataSource : LPCSTR optional
' szWildCardPath : LPCSTR
' mszExpandedPathList : LPSTR optional, out
' pcchPathListLength : DWORD* in/out
' dwFlags : DWORD
Declare PtrSafe Function PdhExpandWildCardPathA Lib "pdh" ( _
    ByVal szDataSource As String, _
    ByVal szWildCardPath As String, _
    ByVal mszExpandedPathList As String, _
    ByRef pcchPathListLength 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

PdhExpandWildCardPathA = ctypes.windll.pdh.PdhExpandWildCardPathA
PdhExpandWildCardPathA.restype = wintypes.DWORD
PdhExpandWildCardPathA.argtypes = [
    wintypes.LPCSTR,  # szDataSource : LPCSTR optional
    wintypes.LPCSTR,  # szWildCardPath : LPCSTR
    wintypes.LPSTR,  # mszExpandedPathList : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchPathListLength : DWORD* in/out
    wintypes.DWORD,  # dwFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhExpandWildCardPathA = Fiddle::Function.new(
  lib['PdhExpandWildCardPathA'],
  [
    Fiddle::TYPE_VOIDP,  # szDataSource : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # szWildCardPath : LPCSTR
    Fiddle::TYPE_VOIDP,  # mszExpandedPathList : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchPathListLength : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhExpandWildCardPathA(
        szDataSource: *const u8,  // LPCSTR optional
        szWildCardPath: *const u8,  // LPCSTR
        mszExpandedPathList: *mut u8,  // LPSTR 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.Ansi)]
public static extern uint PdhExpandWildCardPathA([MarshalAs(UnmanagedType.LPStr)] string szDataSource, [MarshalAs(UnmanagedType.LPStr)] string szWildCardPath, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder mszExpandedPathList, ref uint pcchPathListLength, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhExpandWildCardPathA' -Namespace Win32 -PassThru
# $api::PdhExpandWildCardPathA(szDataSource, szWildCardPath, mszExpandedPathList, pcchPathListLength, dwFlags)

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

出力引数:

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