ホーム › System.Performance › PdhParseCounterPathA

PdhParseCounterPathA

関数

カウンターパスを構成要素に解析する(ANSI版)。

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

シグネチャ

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

DWORD PdhParseCounterPathA(
    LPCSTR szFullPathBuffer,
    PDH_COUNTER_PATH_ELEMENTS_A* pCounterPathElements,   // optional
    DWORD* pdwBufferSize,
    DWORD dwFlags
);

パラメーター

名前	型	方向	説明
szFullPathBuffer	LPCSTR	in	解析対象のカウンターパスを含む Null 終端文字列です。カウンターパスの最大長は PDH_MAX_COUNTER_PATH です。
pCounterPathElements	PDH_COUNTER_PATH_ELEMENTS_A*	outoptional	呼び出し側が割り当てたバッファーで、 PDH_COUNTER_PATH_ELEMENTS 構造体を受け取ります。この構造体には、szFullPathBuffer パラメーターで参照されるパスの個々の文字列要素へのポインターが含まれます。関数はこれらの文字列を PDH_COUNTER_PATH_ELEMENTS 構造体の末尾に追加します。割り当てるバッファーは、構造体と文字列の両方を格納できる十分な大きさである必要があります。pdwBufferSize がゼロの場合は NULL を設定します。
pdwBufferSize	DWORD*	inout	pCounterPathElements バッファーのサイズ(バイト単位)です。入力時にゼロの場合、関数は PDH_MORE_DATA を返し、このパラメーターに必要なバッファーサイズを設定します。バッファーが必要なサイズより大きい場合、関数はこのパラメーターに実際に使用されたバッファーのサイズを設定します。入力時に指定したサイズがゼロより大きいものの必要なサイズより小さい場合、返されたサイズを基にバッファーを再割り当てしないでください。
dwFlags	DWORD	in	予約済みです。ゼロを指定する必要があります。

戻り値の型: DWORD

公式ドキュメント

カウンターパスの各要素を解析し、結果を PDH_COUNTER_PATH_ELEMENTS 構造体に格納します。(ANSI)

戻り値

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

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

戻り値	説明
PDH_INVALID_ARGUMENT	パラメーターが無効です。
PDH_MORE_DATA	pCounterPathElements バッファーが小さすぎて、パス要素を格納できません。この戻り値は、入力時に pdwBufferSize がゼロの場合に想定されるものです。入力時に指定したサイズがゼロより大きいものの必要なサイズより小さい場合、返されたサイズを基にバッファーを再割り当てしないでください。
PDH_INVALID_PATH	パスの形式が正しくないため、解析できません。たとえば、一部のリリースでは、入力時に指定したサイズがゼロより大きいものの必要なサイズより小さい場合に、このエラーを受け取ることがあります。
PDH_MEMORY_ALLOCATION_FAILURE	関数を完了するために必要なメモリを割り当てられません。

解説(Remarks)

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PdhParseCounterPathA(
    LPCSTR szFullPathBuffer,
    PDH_COUNTER_PATH_ELEMENTS_A* pCounterPathElements,   // optional
    DWORD* pdwBufferSize,
    DWORD dwFlags
);

[DllImport("pdh.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint PdhParseCounterPathA(
    [MarshalAs(UnmanagedType.LPStr)] string szFullPathBuffer,   // LPCSTR
    IntPtr pCounterPathElements,   // PDH_COUNTER_PATH_ELEMENTS_A* optional, out
    ref uint pdwBufferSize,   // DWORD* in/out
    uint dwFlags   // DWORD
);

<DllImport("pdh.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PdhParseCounterPathA(
    <MarshalAs(UnmanagedType.LPStr)> szFullPathBuffer As String,   ' LPCSTR
    pCounterPathElements As IntPtr,   ' PDH_COUNTER_PATH_ELEMENTS_A* optional, out
    ByRef pdwBufferSize As UInteger,   ' DWORD* in/out
    dwFlags As UInteger   ' DWORD
) As UInteger
End Function

' szFullPathBuffer : LPCSTR
' pCounterPathElements : PDH_COUNTER_PATH_ELEMENTS_A* optional, out
' pdwBufferSize : DWORD* in/out
' dwFlags : DWORD
Declare PtrSafe Function PdhParseCounterPathA Lib "pdh" ( _
    ByVal szFullPathBuffer As String, _
    ByVal pCounterPathElements As LongPtr, _
    ByRef pdwBufferSize 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

PdhParseCounterPathA = ctypes.windll.pdh.PdhParseCounterPathA
PdhParseCounterPathA.restype = wintypes.DWORD
PdhParseCounterPathA.argtypes = [
    wintypes.LPCSTR,  # szFullPathBuffer : LPCSTR
    ctypes.c_void_p,  # pCounterPathElements : PDH_COUNTER_PATH_ELEMENTS_A* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pdwBufferSize : DWORD* in/out
    wintypes.DWORD,  # dwFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhParseCounterPathA = Fiddle::Function.new(
  lib['PdhParseCounterPathA'],
  [
    Fiddle::TYPE_VOIDP,  # szFullPathBuffer : LPCSTR
    Fiddle::TYPE_VOIDP,  # pCounterPathElements : PDH_COUNTER_PATH_ELEMENTS_A* optional, out
    Fiddle::TYPE_VOIDP,  # pdwBufferSize : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhParseCounterPathA(
        szFullPathBuffer: *const u8,  // LPCSTR
        pCounterPathElements: *mut PDH_COUNTER_PATH_ELEMENTS_A,  // PDH_COUNTER_PATH_ELEMENTS_A* optional, out
        pdwBufferSize: *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 PdhParseCounterPathA([MarshalAs(UnmanagedType.LPStr)] string szFullPathBuffer, IntPtr pCounterPathElements, ref uint pdwBufferSize, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhParseCounterPathA' -Namespace Win32 -PassThru
# $api::PdhParseCounterPathA(szFullPathBuffer, pCounterPathElements, pdwBufferSize, dwFlags)

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

出力引数:

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