ホーム › System.Performance › PdhParseInstanceNameA

PdhParseInstanceNameA

関数

インスタンス文字列を名前と親名に分解する(ANSI版)。

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

シグネチャ

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

DWORD PdhParseInstanceNameA(
    LPCSTR szInstanceString,
    LPSTR szInstanceName,   // optional
    DWORD* pcchInstanceNameLength,
    LPSTR szParentName,   // optional
    DWORD* pcchParentNameLength,
    DWORD* lpIndex
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

関数が失敗した場合、戻り値はシステムエラーコードまたは PDH エラーコードです。次の値が考えられます。

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

解説(Remarks)

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PdhParseInstanceNameA(
    LPCSTR szInstanceString,
    LPSTR szInstanceName,   // optional
    DWORD* pcchInstanceNameLength,
    LPSTR szParentName,   // optional
    DWORD* pcchParentNameLength,
    DWORD* lpIndex
);

[DllImport("pdh.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint PdhParseInstanceNameA(
    [MarshalAs(UnmanagedType.LPStr)] string szInstanceString,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szInstanceName,   // LPSTR optional, out
    ref uint pcchInstanceNameLength,   // DWORD* in/out
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szParentName,   // LPSTR optional, out
    ref uint pcchParentNameLength,   // DWORD* in/out
    out uint lpIndex   // DWORD* out
);

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

' szInstanceString : LPCSTR
' szInstanceName : LPSTR optional, out
' pcchInstanceNameLength : DWORD* in/out
' szParentName : LPSTR optional, out
' pcchParentNameLength : DWORD* in/out
' lpIndex : DWORD* out
Declare PtrSafe Function PdhParseInstanceNameA Lib "pdh" ( _
    ByVal szInstanceString As String, _
    ByVal szInstanceName As String, _
    ByRef pcchInstanceNameLength As Long, _
    ByVal szParentName As String, _
    ByRef pcchParentNameLength As Long, _
    ByRef lpIndex As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhParseInstanceNameA = ctypes.windll.pdh.PdhParseInstanceNameA
PdhParseInstanceNameA.restype = wintypes.DWORD
PdhParseInstanceNameA.argtypes = [
    wintypes.LPCSTR,  # szInstanceString : LPCSTR
    wintypes.LPSTR,  # szInstanceName : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchInstanceNameLength : DWORD* in/out
    wintypes.LPSTR,  # szParentName : LPSTR 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')
PdhParseInstanceNameA = Fiddle::Function.new(
  lib['PdhParseInstanceNameA'],
  [
    Fiddle::TYPE_VOIDP,  # szInstanceString : LPCSTR
    Fiddle::TYPE_VOIDP,  # szInstanceName : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchInstanceNameLength : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # szParentName : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchParentNameLength : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpIndex : DWORD* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhParseInstanceNameA(
        szInstanceString: *const u8,  // LPCSTR
        szInstanceName: *mut u8,  // LPSTR optional, out
        pcchInstanceNameLength: *mut u32,  // DWORD* in/out
        szParentName: *mut u8,  // LPSTR 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.Ansi)]
public static extern uint PdhParseInstanceNameA([MarshalAs(UnmanagedType.LPStr)] string szInstanceString, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szInstanceName, ref uint pcchInstanceNameLength, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szParentName, ref uint pcchParentNameLength, out uint lpIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhParseInstanceNameA' -Namespace Win32 -PassThru
# $api::PdhParseInstanceNameA(szInstanceString, szInstanceName, pcchInstanceNameLength, szParentName, pcchParentNameLength, lpIndex)

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

出力引数:

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