ホーム › System.Performance › PdhLookupPerfIndexByNameA

PdhLookupPerfIndexByNameA

関数

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

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

シグネチャ

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

DWORD PdhLookupPerfIndexByNameA(
    LPCSTR szMachineName,   // optional
    LPCSTR szNameBuffer,
    DWORD* pdwIndex
);

パラメーター

名前	型	方向	説明
szMachineName	LPCSTR	inoptional	指定したカウンターが存在するコンピューターの名前を指定する Null 終端文字列です。コンピューター名は DNS 名または IP アドレスで指定できます。NULL の場合、この関数はローカルコンピューターを使用します。
szNameBuffer	LPCSTR	in	カウンター名を格納した Null 終端文字列です。
pdwIndex	DWORD*	out	カウンターのインデックスです。

戻り値の型: DWORD

公式ドキュメント

指定したカウンター名に対応するカウンターのインデックスを返します。(ANSI)

戻り値

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

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

戻り値	説明
PDH_INVALID_ARGUMENT	パラメーターが無効であるか、形式が正しくありません。

解説(Remarks)

メモ

pdh.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして、PdhLookupPerfIndexByName を定義します。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在して使用すると、不一致が生じてコンパイルエラーや実行時エラーを引き起こすおそれがあります。詳細については、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 PdhLookupPerfIndexByNameA(
    LPCSTR szMachineName,   // optional
    LPCSTR szNameBuffer,
    DWORD* pdwIndex
);

[DllImport("pdh.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint PdhLookupPerfIndexByNameA(
    [MarshalAs(UnmanagedType.LPStr)] string szMachineName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string szNameBuffer,   // LPCSTR
    out uint pdwIndex   // DWORD* out
);

<DllImport("pdh.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PdhLookupPerfIndexByNameA(
    <MarshalAs(UnmanagedType.LPStr)> szMachineName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> szNameBuffer As String,   ' LPCSTR
    <Out> ByRef pdwIndex As UInteger   ' DWORD* out
) As UInteger
End Function

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

import ctypes
from ctypes import wintypes

PdhLookupPerfIndexByNameA = ctypes.windll.pdh.PdhLookupPerfIndexByNameA
PdhLookupPerfIndexByNameA.restype = wintypes.DWORD
PdhLookupPerfIndexByNameA.argtypes = [
    wintypes.LPCSTR,  # szMachineName : LPCSTR optional
    wintypes.LPCSTR,  # szNameBuffer : LPCSTR
    ctypes.POINTER(wintypes.DWORD),  # pdwIndex : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhLookupPerfIndexByNameA = Fiddle::Function.new(
  lib['PdhLookupPerfIndexByNameA'],
  [
    Fiddle::TYPE_VOIDP,  # szMachineName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # szNameBuffer : LPCSTR
    Fiddle::TYPE_VOIDP,  # pdwIndex : DWORD* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhLookupPerfIndexByNameA(
        szMachineName: *const u8,  // LPCSTR optional
        szNameBuffer: *const u8,  // LPCSTR
        pdwIndex: *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 PdhLookupPerfIndexByNameA([MarshalAs(UnmanagedType.LPStr)] string szMachineName, [MarshalAs(UnmanagedType.LPStr)] string szNameBuffer, out uint pdwIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhLookupPerfIndexByNameA' -Namespace Win32 -PassThru
# $api::PdhLookupPerfIndexByNameA(szMachineName, szNameBuffer, pdwIndex)

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

出力引数:

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