ホーム › System.Performance › PdhMakeCounterPathW

PdhMakeCounterPathW

関数

構成要素から完全なカウンターパス文字列を生成する。

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

シグネチャ

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

DWORD PdhMakeCounterPathW(
    PDH_COUNTER_PATH_ELEMENTS_W* pCounterPathElements,
    LPWSTR szFullPathBuffer,   // optional
    DWORD* pcchBufferSize,
    PDH_PATH_FLAGS dwFlags
);

パラメーター

名前

型

方向

説明

pCounterPathElements

PDH_COUNTER_PATH_ELEMENTS_W*

パスを構成するために使用するメンバーを格納した PDH_COUNTER_PATH_ELEMENTS 構造体です。必須なのは szObjectName メンバーと szCounterName メンバーのみで、その他は省略可能です。

インスタンス名メンバーが NULL の場合、パスにはインスタンス参照が含まれず、szParentInstance メンバーと dwInstanceIndex メンバーは無視されます。

szFullPathBuffer

LPWSTR

outoptional

null で終端されたカウンターパスを受け取る、呼び出し側が割り当てるバッファーです。カウンターパスの最大長は PDH_MAX_COUNTER_PATH です。pcchBufferSize が 0 の場合は NULL を設定します。

pcchBufferSize

DWORD*

inout

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

dwFlags

PDH_PATH_FLAGS

入力および出力のカウンター値の形式です。次のいずれかの値を指定できます。

値	意味
PDH_PATH_WBEM_RESULT	PDH パスを WMI のクラス名およびプロパティ名の形式に変換します。
PDH_PATH_WBEM_INPUT	WMI のクラス名およびプロパティ名を PDH パスに変換します。
0	PDH 形式でパスを返します。例: \\computer\object(parent/instance#index)\counter。

戻り値の型: DWORD

公式ドキュメント

PDH_COUNTER_PATH_ELEMENTS 構造体で指定されたメンバーを使用して、完全なカウンターパスを作成します。(Unicode)

戻り値

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

関数が失敗した場合、戻り値はシステムエラーコードまたは PDH エラーコードです。次の値が返される可能性があります。

戻り値	説明
PDH_MORE_DATA	szFullPathBuffer バッファーが小さすぎてカウンター名を格納できません。pcchBufferSize が入力時に 0 の場合、この戻り値が返されることが想定されています。入力時に指定したサイズが 0 より大きく必要なサイズより小さい場合、返されたサイズに基づいてバッファーを再割り当てしないでください。
PDH_INVALID_ARGUMENT	パラメーターが無効であるか、形式が正しくありません。たとえば、一部のリリースでは、入力時に指定したサイズが 0 より大きく必要なサイズより小さい場合に、このエラーが返されることがあります。

戻り値

説明

PDH_MORE_DATA

szFullPathBuffer バッファーが小さすぎてカウンター名を格納できません。pcchBufferSize が入力時に 0 の場合、この戻り値が返されることが想定されています。入力時に指定したサイズが 0 より大きく必要なサイズより小さい場合、返されたサイズに基づいてバッファーを再割り当てしないでください。

PDH_INVALID_ARGUMENT

パラメーターが無効であるか、形式が正しくありません。たとえば、一部のリリースでは、入力時に指定したサイズが 0 より大きく必要なサイズより小さい場合に、このエラーが返されることがあります。

解説(Remarks)

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

メモ

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

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

[DllImport("pdh.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PdhMakeCounterPathW(
    IntPtr pCounterPathElements,   // PDH_COUNTER_PATH_ELEMENTS_W*
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szFullPathBuffer,   // LPWSTR optional, out
    ref uint pcchBufferSize,   // DWORD* in/out
    uint dwFlags   // PDH_PATH_FLAGS
);

<DllImport("pdh.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PdhMakeCounterPathW(
    pCounterPathElements As IntPtr,   ' PDH_COUNTER_PATH_ELEMENTS_W*
    <MarshalAs(UnmanagedType.LPWStr)> szFullPathBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcchBufferSize As UInteger,   ' DWORD* in/out
    dwFlags As UInteger   ' PDH_PATH_FLAGS
) As UInteger
End Function

' pCounterPathElements : PDH_COUNTER_PATH_ELEMENTS_W*
' szFullPathBuffer : LPWSTR optional, out
' pcchBufferSize : DWORD* in/out
' dwFlags : PDH_PATH_FLAGS
Declare PtrSafe Function PdhMakeCounterPathW Lib "pdh" ( _
    ByVal pCounterPathElements As LongPtr, _
    ByVal szFullPathBuffer As LongPtr, _
    ByRef pcchBufferSize 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

PdhMakeCounterPathW = ctypes.windll.pdh.PdhMakeCounterPathW
PdhMakeCounterPathW.restype = wintypes.DWORD
PdhMakeCounterPathW.argtypes = [
    ctypes.c_void_p,  # pCounterPathElements : PDH_COUNTER_PATH_ELEMENTS_W*
    wintypes.LPWSTR,  # szFullPathBuffer : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchBufferSize : DWORD* in/out
    wintypes.DWORD,  # dwFlags : PDH_PATH_FLAGS
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhMakeCounterPathW = Fiddle::Function.new(
  lib['PdhMakeCounterPathW'],
  [
    Fiddle::TYPE_VOIDP,  # pCounterPathElements : PDH_COUNTER_PATH_ELEMENTS_W*
    Fiddle::TYPE_VOIDP,  # szFullPathBuffer : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchBufferSize : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwFlags : PDH_PATH_FLAGS
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "pdh")]
extern "system" {
    fn PdhMakeCounterPathW(
        pCounterPathElements: *mut PDH_COUNTER_PATH_ELEMENTS_W,  // PDH_COUNTER_PATH_ELEMENTS_W*
        szFullPathBuffer: *mut u16,  // LPWSTR optional, out
        pcchBufferSize: *mut u32,  // DWORD* in/out
        dwFlags: u32  // PDH_PATH_FLAGS
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("pdh.dll", CharSet = CharSet.Unicode)]
public static extern uint PdhMakeCounterPathW(IntPtr pCounterPathElements, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szFullPathBuffer, ref uint pcchBufferSize, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhMakeCounterPathW' -Namespace Win32 -PassThru
# $api::PdhMakeCounterPathW(pCounterPathElements, szFullPathBuffer, pcchBufferSize, dwFlags)

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

出力引数:

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