ホーム › System.Performance › PdhLookupPerfNameByIndexW

PdhLookupPerfNameByIndexW

関数

インデックス番号から対応するパフォーマンス名を取得する。

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

シグネチャ

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

DWORD PdhLookupPerfNameByIndexW(
    LPCWSTR szMachineName,   // optional
    DWORD dwNameIndex,
    LPWSTR szNameBuffer,   // optional
    DWORD* pcchNameBufferSize
);

パラメーター

名前	型	方向	説明
szMachineName	LPCWSTR	inoptional	指定したパフォーマンスオブジェクトまたはカウンターが存在するコンピューターの名前を指定する Null 終端文字列です。コンピューター名は DNS 名または IP アドレスで指定できます。NULL の場合、関数はローカルコンピューターを使用します。
dwNameIndex	DWORD	in	パフォーマンスオブジェクトまたはカウンターのインデックスです。
szNameBuffer	LPWSTR	outoptional	パフォーマンスオブジェクトまたはカウンターの null 終端の名前を受け取る、呼び出し元が割り当てたバッファーです。pcchNameBufferSize がゼロの場合は NULL に設定します。
pcchNameBufferSize	DWORD*	inout	szNameBuffer バッファーのサイズ(TCHAR 単位)です。入力時にゼロの場合、関数は PDH_MORE_DATA を返し、このパラメーターに必要なバッファーサイズを設定します。バッファーが必要なサイズより大きい場合、関数はこのパラメーターに実際に使用されたバッファーのサイズを設定します。入力時に指定したサイズがゼロより大きく、かつ必要なサイズより小さい場合、返されたサイズを基にバッファーを再割り当てしないでください。

戻り値の型: DWORD

公式ドキュメント

指定されたインデックスに対応するパフォーマンスオブジェクト名またはカウンター名を返します。(Unicode)

戻り値

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

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

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

戻り値

説明

PDH_MORE_DATA

szNameBuffer バッファーがカウンター名を格納するのに十分な大きさではありません。pcchNameBufferSize が入力時にゼロの場合、この戻り値が想定されます。入力時に指定したサイズがゼロより大きく、かつ必要なサイズより小さい場合、返されたサイズを基にバッファーを再割り当てしないでください。

PDH_INVALID_ARGUMENT

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

解説(Remarks)

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

Windows XP: バッファーとバッファーサイズを指定する必要があります。関数は pcchNameBufferSize に、必要なサイズまたは使用されたバッファーのサイズのいずれかを設定します。バッファーが小さすぎる場合、関数は PDH_MORE_DATA ではなく PDH_INSUFFICIENT_BUFFER を返します。バイト単位の最大文字列サイズは PDH_MAX_COUNTER_NAME * sizeof(TCHAR) です。

指定するインデックス値は、コンピューターに読み込まれているオブジェクトまたはカウンターに関連付けられたインデックス値のいずれかに一致する必要があります。インデックスと名前の値のペアは、次のレジストリの場所にある Counters レジストリ値に格納されています。

HKEY_LOCAL_MACHINE
   \SOFTWARE
      \Microsoft
         \Windows NT
            \CurrentVersion
               \Perflib
                  Last Counter = 最大のカウンターインデックス
                  Last Help = 最大のヘルプインデックス
                  \009
                     Counters = 2 System 4 Memory...
                     Help = 3 The System Object Type...
                  \英語以外のサポートされている言語
                     Counters = ...
                     Help = ...

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PdhLookupPerfNameByIndexW(
    LPCWSTR szMachineName,   // optional
    DWORD dwNameIndex,
    LPWSTR szNameBuffer,   // optional
    DWORD* pcchNameBufferSize
);

[DllImport("pdh.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PdhLookupPerfNameByIndexW(
    [MarshalAs(UnmanagedType.LPWStr)] string szMachineName,   // LPCWSTR optional
    uint dwNameIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szNameBuffer,   // LPWSTR optional, out
    ref uint pcchNameBufferSize   // DWORD* in/out
);

<DllImport("pdh.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PdhLookupPerfNameByIndexW(
    <MarshalAs(UnmanagedType.LPWStr)> szMachineName As String,   ' LPCWSTR optional
    dwNameIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> szNameBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcchNameBufferSize As UInteger   ' DWORD* in/out
) As UInteger
End Function

' szMachineName : LPCWSTR optional
' dwNameIndex : DWORD
' szNameBuffer : LPWSTR optional, out
' pcchNameBufferSize : DWORD* in/out
Declare PtrSafe Function PdhLookupPerfNameByIndexW Lib "pdh" ( _
    ByVal szMachineName As LongPtr, _
    ByVal dwNameIndex As Long, _
    ByVal szNameBuffer As LongPtr, _
    ByRef pcchNameBufferSize 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

PdhLookupPerfNameByIndexW = ctypes.windll.pdh.PdhLookupPerfNameByIndexW
PdhLookupPerfNameByIndexW.restype = wintypes.DWORD
PdhLookupPerfNameByIndexW.argtypes = [
    wintypes.LPCWSTR,  # szMachineName : LPCWSTR optional
    wintypes.DWORD,  # dwNameIndex : DWORD
    wintypes.LPWSTR,  # szNameBuffer : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchNameBufferSize : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhLookupPerfNameByIndexW = Fiddle::Function.new(
  lib['PdhLookupPerfNameByIndexW'],
  [
    Fiddle::TYPE_VOIDP,  # szMachineName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwNameIndex : DWORD
    Fiddle::TYPE_VOIDP,  # szNameBuffer : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchNameBufferSize : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "pdh")]
extern "system" {
    fn PdhLookupPerfNameByIndexW(
        szMachineName: *const u16,  // LPCWSTR optional
        dwNameIndex: u32,  // DWORD
        szNameBuffer: *mut u16,  // LPWSTR optional, out
        pcchNameBufferSize: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("pdh.dll", CharSet = CharSet.Unicode)]
public static extern uint PdhLookupPerfNameByIndexW([MarshalAs(UnmanagedType.LPWStr)] string szMachineName, uint dwNameIndex, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szNameBuffer, ref uint pcchNameBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhLookupPerfNameByIndexW' -Namespace Win32 -PassThru
# $api::PdhLookupPerfNameByIndexW(szMachineName, dwNameIndex, szNameBuffer, pcchNameBufferSize)

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

出力引数:

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