ホーム › System.Performance › PdhLookupPerfIndexByNameW

PdhLookupPerfIndexByNameW

関数

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

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

シグネチャ

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

DWORD PdhLookupPerfIndexByNameW(
    LPCWSTR szMachineName,   // optional
    LPCWSTR szNameBuffer,
    DWORD* pdwIndex
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

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

解説(Remarks)

メモ

pdh.h ヘッダーは PdhLookupPerfIndexByName をエイリアスとして定義しており、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 PdhLookupPerfIndexByNameW(
    LPCWSTR szMachineName,   // optional
    LPCWSTR szNameBuffer,
    DWORD* pdwIndex
);

[DllImport("pdh.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PdhLookupPerfIndexByNameW(
    [MarshalAs(UnmanagedType.LPWStr)] string szMachineName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string szNameBuffer,   // LPCWSTR
    out uint pdwIndex   // DWORD* out
);

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

' szMachineName : LPCWSTR optional
' szNameBuffer : LPCWSTR
' pdwIndex : DWORD* out
Declare PtrSafe Function PdhLookupPerfIndexByNameW Lib "pdh" ( _
    ByVal szMachineName As LongPtr, _
    ByVal szNameBuffer As LongPtr, _
    ByRef pdwIndex 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

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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