ホーム › System.Performance › PdhLookupPerfNameByIndexA

PdhLookupPerfNameByIndexA

関数

インデックスからパフォーマンス名を取得する(ANSI版)。

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

シグネチャ

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

DWORD PdhLookupPerfNameByIndexA(
    LPCSTR szMachineName,   // optional
    DWORD dwNameIndex,
    LPSTR szNameBuffer,   // optional
    DWORD* pcchNameBufferSize
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

関数が成功すると、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 = highest counter index
                  Last Help = highest help index
                  \009
                     Counters = 2 System 4 Memory...
                     Help = 3 The System Object Type...
                  \supported language, other than English
                     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  (ANSI / -A)
#include <windows.h>

DWORD PdhLookupPerfNameByIndexA(
    LPCSTR szMachineName,   // optional
    DWORD dwNameIndex,
    LPSTR szNameBuffer,   // optional
    DWORD* pcchNameBufferSize
);

[DllImport("pdh.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint PdhLookupPerfNameByIndexA(
    [MarshalAs(UnmanagedType.LPStr)] string szMachineName,   // LPCSTR optional
    uint dwNameIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szNameBuffer,   // LPSTR optional, out
    ref uint pcchNameBufferSize   // DWORD* in/out
);

<DllImport("pdh.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PdhLookupPerfNameByIndexA(
    <MarshalAs(UnmanagedType.LPStr)> szMachineName As String,   ' LPCSTR optional
    dwNameIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> szNameBuffer As System.Text.StringBuilder,   ' LPSTR optional, out
    ByRef pcchNameBufferSize As UInteger   ' DWORD* in/out
) As UInteger
End Function

' szMachineName : LPCSTR optional
' dwNameIndex : DWORD
' szNameBuffer : LPSTR optional, out
' pcchNameBufferSize : DWORD* in/out
Declare PtrSafe Function PdhLookupPerfNameByIndexA Lib "pdh" ( _
    ByVal szMachineName As String, _
    ByVal dwNameIndex As Long, _
    ByVal szNameBuffer As String, _
    ByRef pcchNameBufferSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhLookupPerfNameByIndexA = Fiddle::Function.new(
  lib['PdhLookupPerfNameByIndexA'],
  [
    Fiddle::TYPE_VOIDP,  # szMachineName : LPCSTR optional
    -Fiddle::TYPE_INT,  # dwNameIndex : DWORD
    Fiddle::TYPE_VOIDP,  # szNameBuffer : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchNameBufferSize : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhLookupPerfNameByIndexA(
        szMachineName: *const u8,  // LPCSTR optional
        dwNameIndex: u32,  // DWORD
        szNameBuffer: *mut u8,  // LPSTR 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.Ansi)]
public static extern uint PdhLookupPerfNameByIndexA([MarshalAs(UnmanagedType.LPStr)] string szMachineName, uint dwNameIndex, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szNameBuffer, ref uint pcchNameBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhLookupPerfNameByIndexA' -Namespace Win32 -PassThru
# $api::PdhLookupPerfNameByIndexA(szMachineName, dwNameIndex, szNameBuffer, pcchNameBufferSize)

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

出力引数:

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