ホーム › System.Performance › PdhExpandCounterPathW

PdhExpandCounterPathW

関数

ワイルドカードを含むパスを完全なパス一覧に展開する。

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

シグネチャ

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

DWORD PdhExpandCounterPathW(
    LPCWSTR szWildCardPath,
    LPWSTR mszExpandedPathList,   // optional
    DWORD* pcchPathListLength
);

パラメーター

名前	型	方向	説明
szWildCardPath	LPCWSTR	in	展開するカウンターパスを含む Null 終端文字列です。この関数は、パスで指定されたコンピューターを検索して一致するものを探します。パスにコンピューターが指定されていない場合は、ローカルコンピューターを検索します。カウンターパスの最大長は PDH_MAX_COUNTER_PATH です。
mszExpandedPathList	LPWSTR	outoptional	呼び出し側が確保するバッファーで、szWildCardPath 内のワイルドカード指定に一致する、展開されたカウンターパスの一覧を受け取ります。この一覧内の各カウンターパスは null 文字で終端されます。一覧全体は 2 つの NULL 文字で終端されます。pcchPathListLength が 0 の場合は NULL を設定してください。
pcchPathListLength	DWORD*	inout	mszExpandedPathList バッファーのサイズを TCHAR 単位で指定します。入力時に 0 の場合、関数は PDH_MORE_DATA を返し、このパラメーターに必要なバッファーサイズを設定します。バッファーが必要なサイズより大きい場合、関数は実際に使用されたバッファーのサイズをこのパラメーターに設定します。入力時に指定したサイズが 0 より大きく、かつ必要なサイズより小さい場合、返されたサイズをバッファーの再確保に使用すべきではありません。注 Windows XP では、必要なサイズに 1 を加算する必要があります。

戻り値の型: DWORD

公式ドキュメント

指定したコンピューター(指定しない場合はローカルコンピューター)を調べ、カウンターパス内のワイルドカード文字列に一致するカウンターおよびカウンターのインスタンスを取得します。(Unicode)

戻り値

関数が成功すると、ERROR_SUCCESS を返します。

関数が失敗すると、戻り値はシステムエラーコードまたは PDH エラーコードになります。

戻り値	説明
PDH_MORE_DATA	mszExpandedPathList バッファーが小さすぎて、パスの一覧を格納できません。この戻り値は、入力時に pcchPathListLength が 0 の場合に想定されるものです。入力時に指定したサイズが 0 より大きく、かつ必要なサイズより小さい場合、返されたサイズをバッファーの再確保に使用すべきではありません。
PDH_INVALID_ARGUMENT	パラメーターが無効です。たとえば、一部のリリースでは、入力時に指定したサイズが 0 より大きく、かつ必要なサイズより小さい場合にこのエラーが返されることがあります。
PDH_MEMORY_ALLOCATION_FAILURE	この関数の処理に必要なメモリを確保できません。

解説(Remarks)

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

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

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

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

使用すべきカウンターパスはカウンター自体によって決まります。たとえば、LogicalDisk オブジェクトにはインスタンスインデックスがあるため、#index またはワイルドカードを指定する必要があります。したがって、次の形式を使用できます。

\LogicalDisk(/#*)*

対照的に、Process オブジェクトはインスタンスインデックスを必要としません。したがって、次の形式を使用できます。

\Process(*)\ID Process

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

\\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

parent 名にワイルドカード文字が指定されている場合、指定された instance フィールドと counter フィールドに一致する、指定オブジェクトのすべてのインスタンスが返されます。

instance 名にワイルドカード文字が指定されている場合、指定されたインデックスに対応するすべてのインスタンス名がワイルドカード文字に一致すれば、指定オブジェクトおよび親オブジェクトのすべてのインスタンスが返されます。

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

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

例

次の例は、この関数の使用方法を示しています。


#include <windows.h>
#include <stdio.h>
#include <stdlib.h>
#include <pdh.h>
#include <pdhmsg.h>

#pragma comment(lib, "pdh.lib")

CONST PWSTR WILDCARD_PATH = L"\\Processor(*)\\*";

void wmain(void)
{
    PDH_STATUS Status;
    PWSTR EndOfPaths;
    PWSTR Paths = NULL;
    DWORD BufferSize = 0;

    Status = PdhExpandCounterPath(WILDCARD_PATH, Paths, &BufferSize);

    while (Status == PDH_MORE_DATA) 
    {
        Paths = (PWSTR)malloc(BufferSize * sizeof(WCHAR));
        Status = PdhExpandCounterPath(WILDCARD_PATH, Paths, &BufferSize);
    }

    if (Status != ERROR_SUCCESS) 
    {
        wprintf(L"\nPdhExpandCounterPath failed with status 0x%x", Status);
        goto Cleanup;
    }

    if (Paths == NULL) 
    {
        wprintf(L"\nThe counter path %s cannot be expanded.", WILDCARD_PATH);
        goto Cleanup;
    }

    EndOfPaths = Paths + BufferSize;

    // On Vista and later operating systems, the buffer is terminated with two 
    // null-terminator characters; however, on earlier systems, the buffer is
    // not terminated with two null-terminator characters. This covers both cases.
    for (PWSTR p = Paths; ((p != EndOfPaths) && (*p != L'\0')); p += wcslen(p) + 1) 
    {
        wprintf(L"\n%s", p);
    }

Cleanup:
    if (Paths) 
    {
        free(Paths);
    }
}

メモ

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

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

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

<DllImport("pdh.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PdhExpandCounterPathW(
    <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
) As UInteger
End Function

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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "pdh")]
extern "system" {
    fn PdhExpandCounterPathW(
        szWildCardPath: *const u16,  // LPCWSTR
        mszExpandedPathList: *mut u16,  // LPWSTR optional, out
        pcchPathListLength: *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 PdhExpandCounterPathW([MarshalAs(UnmanagedType.LPWStr)] string szWildCardPath, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszExpandedPathList, ref uint pcchPathListLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhExpandCounterPathW' -Namespace Win32 -PassThru
# $api::PdhExpandCounterPathW(szWildCardPath, mszExpandedPathList, pcchPathListLength)

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

出力引数:

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