ホーム › System.Performance › PdhParseInstanceNameW

PdhParseInstanceNameW

関数

インスタンス文字列をインスタンス名と親名に分解する。

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

シグネチャ

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

DWORD PdhParseInstanceNameW(
    LPCWSTR szInstanceString,
    LPWSTR szInstanceName,   // optional
    DWORD* pcchInstanceNameLength,
    LPWSTR szParentName,   // optional
    DWORD* pcchParentNameLength,
    DWORD* lpIndex
);

パラメーター

名前	型	方向	説明
szInstanceString	LPCWSTR	in	個々のコンポーネントに解析するインスタンス文字列を指定するnull終端文字列です。この文字列には次の形式を指定でき、長さは MAX_PATH 文字未満である必要があります。 instance instance#index parent/instance parent/instance#index
szInstanceName	LPWSTR	outoptional	null終端のインスタンス名を受け取る、呼び出し元が確保したバッファーです。pcchInstanceNameLength が 0 の場合は NULL に設定します。
pcchInstanceNameLength	DWORD*	inout	szInstanceName バッファーのサイズ(TCHAR 単位)です。入力時に 0 の場合、関数は PDH_MORE_DATA を返し、このパラメーターに必要なバッファーサイズを設定します。バッファーが必要なサイズより大きい場合、関数はこのパラメーターに実際に使用されたバッファーのサイズを設定します。入力時に指定したサイズが 0 より大きく必要なサイズより小さい場合、返されたサイズを使ってバッファーを再確保しないでください。
szParentName	LPWSTR	outoptional	親インスタンスが指定されている場合に、そのnull終端の名前を受け取る、呼び出し元が確保したバッファーです。pcchParentNameLength が 0 の場合は NULL に設定します。
pcchParentNameLength	DWORD*	inout	szParentName バッファーのサイズ(TCHAR 単位)です。入力時に 0 の場合、関数は PDH_MORE_DATA を返し、このパラメーターに必要なバッファーサイズを設定します。バッファーが必要なサイズより大きい場合、関数はこのパラメーターに実際に使用されたバッファーのサイズを設定します。入力時に指定したサイズが 0 より大きく必要なサイズより小さい場合、返されたサイズを使ってバッファーを再確保しないでください。
lpIndex	DWORD*	out	インスタンスのインデックス値です。文字列にインデックスエントリが存在しない場合、この値は 0 になります。このパラメーターには NULL を指定できます。

戻り値の型: DWORD

公式ドキュメント

インスタンス文字列の要素を解析します。(Unicode)

戻り値

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

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

戻り値	説明
PDH_INVALID_ARGUMENT	パラメーターが無効です。たとえば一部のリリースでは、入力時に指定したサイズが 0 より大きく必要なサイズより小さい場合に、このエラーが返されることがあります。
PDH_MORE_DATA	一方または両方の文字列バッファーがデータを格納するには小さすぎます。対応するサイズバッファーが入力時に 0 の場合、この戻り値が返されることが想定されます。入力時に指定したサイズが 0 より大きく必要なサイズより小さい場合、返されたサイズを使ってバッファーを再確保しないでください。
PDH_INVALID_INSTANCE	インスタンス文字列の形式が正しくないか、長さが MAX_PATH 文字を超えているか、または解析できません。

解説(Remarks)

この関数は 2 回呼び出してください。1 回目は必要なバッファーサイズを取得するため(バッファーを NULL に、バッファーサイズを 0 に設定)、2 回目はデータを取得するためです。

メモ

pdh.h ヘッダーは PdhParseInstanceName を、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 PdhParseInstanceNameW(
    LPCWSTR szInstanceString,
    LPWSTR szInstanceName,   // optional
    DWORD* pcchInstanceNameLength,
    LPWSTR szParentName,   // optional
    DWORD* pcchParentNameLength,
    DWORD* lpIndex
);

[DllImport("pdh.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PdhParseInstanceNameW(
    [MarshalAs(UnmanagedType.LPWStr)] string szInstanceString,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szInstanceName,   // LPWSTR optional, out
    ref uint pcchInstanceNameLength,   // DWORD* in/out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szParentName,   // LPWSTR optional, out
    ref uint pcchParentNameLength,   // DWORD* in/out
    out uint lpIndex   // DWORD* out
);

<DllImport("pdh.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PdhParseInstanceNameW(
    <MarshalAs(UnmanagedType.LPWStr)> szInstanceString As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> szInstanceName As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcchInstanceNameLength As UInteger,   ' DWORD* in/out
    <MarshalAs(UnmanagedType.LPWStr)> szParentName As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcchParentNameLength As UInteger,   ' DWORD* in/out
    <Out> ByRef lpIndex As UInteger   ' DWORD* out
) As UInteger
End Function

' szInstanceString : LPCWSTR
' szInstanceName : LPWSTR optional, out
' pcchInstanceNameLength : DWORD* in/out
' szParentName : LPWSTR optional, out
' pcchParentNameLength : DWORD* in/out
' lpIndex : DWORD* out
Declare PtrSafe Function PdhParseInstanceNameW Lib "pdh" ( _
    ByVal szInstanceString As LongPtr, _
    ByVal szInstanceName As LongPtr, _
    ByRef pcchInstanceNameLength As Long, _
    ByVal szParentName As LongPtr, _
    ByRef pcchParentNameLength As Long, _
    ByRef lpIndex 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

PdhParseInstanceNameW = ctypes.windll.pdh.PdhParseInstanceNameW
PdhParseInstanceNameW.restype = wintypes.DWORD
PdhParseInstanceNameW.argtypes = [
    wintypes.LPCWSTR,  # szInstanceString : LPCWSTR
    wintypes.LPWSTR,  # szInstanceName : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchInstanceNameLength : DWORD* in/out
    wintypes.LPWSTR,  # szParentName : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchParentNameLength : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # lpIndex : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhParseInstanceNameW = Fiddle::Function.new(
  lib['PdhParseInstanceNameW'],
  [
    Fiddle::TYPE_VOIDP,  # szInstanceString : LPCWSTR
    Fiddle::TYPE_VOIDP,  # szInstanceName : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchInstanceNameLength : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # szParentName : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchParentNameLength : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpIndex : DWORD* out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "pdh")]
extern "system" {
    fn PdhParseInstanceNameW(
        szInstanceString: *const u16,  // LPCWSTR
        szInstanceName: *mut u16,  // LPWSTR optional, out
        pcchInstanceNameLength: *mut u32,  // DWORD* in/out
        szParentName: *mut u16,  // LPWSTR optional, out
        pcchParentNameLength: *mut u32,  // DWORD* in/out
        lpIndex: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("pdh.dll", CharSet = CharSet.Unicode)]
public static extern uint PdhParseInstanceNameW([MarshalAs(UnmanagedType.LPWStr)] string szInstanceString, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szInstanceName, ref uint pcchInstanceNameLength, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szParentName, ref uint pcchParentNameLength, out uint lpIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhParseInstanceNameW' -Namespace Win32 -PassThru
# $api::PdhParseInstanceNameW(szInstanceString, szInstanceName, pcchInstanceNameLength, szParentName, pcchParentNameLength, lpIndex)

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

出力引数:

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