ホーム › System.Performance › PdhExpandCounterPathA

PdhExpandCounterPathA

関数

ワイルドカードパスをパス一覧に展開する(ANSI版)。

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

シグネチャ

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

DWORD PdhExpandCounterPathA(
    LPCSTR szWildCardPath,
    LPSTR mszExpandedPathList,   // optional
    DWORD* pcchPathListLength
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

関数が成功した場合は、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  (ANSI / -A)
#include <windows.h>

DWORD PdhExpandCounterPathA(
    LPCSTR szWildCardPath,
    LPSTR mszExpandedPathList,   // optional
    DWORD* pcchPathListLength
);

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

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

' szWildCardPath : LPCSTR
' mszExpandedPathList : LPSTR optional, out
' pcchPathListLength : DWORD* in/out
Declare PtrSafe Function PdhExpandCounterPathA Lib "pdh" ( _
    ByVal szWildCardPath As String, _
    ByVal mszExpandedPathList As String, _
    ByRef pcchPathListLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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