ホーム › System.Performance › PdhGetDefaultPerfObjectHW

PdhGetDefaultPerfObjectHW

関数

ハンドル指定で既定オブジェクト名を取得する。

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

シグネチャ

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

DWORD PdhGetDefaultPerfObjectHW(
    PDH_HLOG hDataSource,   // optional
    LPCWSTR szMachineName,   // optional
    LPWSTR szDefaultObjectName,   // optional
    DWORD* pcchBufferSize
);

パラメーター

名前	型	方向	説明
hDataSource	PDH_HLOG	inoptional	NULL を指定してください。ログファイルのハンドルを指定した場合、szDefaultObjectName は null 文字列になります。
szMachineName	LPCWSTR	inoptional	オブジェクト名の検証に使用するコンピューターの名前を指定する null 終端文字列です。NULL の場合は、ローカルコンピューターを使用して名前を検証します。
szDefaultObjectName	LPWSTR	outoptional	null 終端の既定オブジェクト名を受け取る、呼び出し側で割り当てたバッファーです。pcchBufferSize がゼロの場合は NULL に設定してください。なお、PDH は既定オブジェクト名として常に Processor を返します。
pcchBufferSize	DWORD*	inout	szDefaultObjectName バッファーのサイズ(TCHAR 単位)です。入力時にゼロの場合、関数は PDH_MORE_DATA を返し、このパラメーターに必要なバッファーサイズを設定します。バッファーが必要なサイズより大きい場合、関数はこのパラメーターに実際に使用したバッファーのサイズを設定します。入力時に指定したサイズがゼロより大きく必要なサイズより小さい場合、返されたサイズをバッファーの再割り当てに利用しないでください。

戻り値の型: DWORD

公式ドキュメント

既定のオブジェクトの名前を取得します。(Unicode)

戻り値

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

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

戻り値	説明
PDH_MORE_DATA	szDefaultObjectName バッファーが小さすぎてオブジェクト名を格納できません。この戻り値は、入力時に pcchBufferSize がゼロの場合に想定される結果です。入力時に指定したサイズがゼロより大きく必要なサイズより小さい場合、返されたサイズをバッファーの再割り当てに利用しないでください。
PDH_INVALID_ARGUMENT	必須パラメーターが無効です。たとえば、一部のリリースでは、入力時に指定したサイズがゼロより大きく必要なサイズより小さい場合にこのエラーが返されることがあります。
PDH_MEMORY_ALLOCATION_FAILURE	関数を完了するためのメモリを割り当てられません。
PDH_CSTATUS_NO_MACHINE	指定したコンピューターがオフラインまたは利用できません。
PDH_CSTATUS_NO_COUNTERNAME	既定オブジェクト名を読み取れない、または見つかりません。

解説(Remarks)

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

メモ

pdh.h ヘッダーは、PdhGetDefaultPerfObjectH を、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 PdhGetDefaultPerfObjectHW(
    PDH_HLOG hDataSource,   // optional
    LPCWSTR szMachineName,   // optional
    LPWSTR szDefaultObjectName,   // optional
    DWORD* pcchBufferSize
);

[DllImport("pdh.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PdhGetDefaultPerfObjectHW(
    IntPtr hDataSource,   // PDH_HLOG optional
    [MarshalAs(UnmanagedType.LPWStr)] string szMachineName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szDefaultObjectName,   // LPWSTR optional, out
    ref uint pcchBufferSize   // DWORD* in/out
);

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

' hDataSource : PDH_HLOG optional
' szMachineName : LPCWSTR optional
' szDefaultObjectName : LPWSTR optional, out
' pcchBufferSize : DWORD* in/out
Declare PtrSafe Function PdhGetDefaultPerfObjectHW Lib "pdh" ( _
    ByVal hDataSource As LongPtr, _
    ByVal szMachineName As LongPtr, _
    ByVal szDefaultObjectName As LongPtr, _
    ByRef pcchBufferSize 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

PdhGetDefaultPerfObjectHW = ctypes.windll.pdh.PdhGetDefaultPerfObjectHW
PdhGetDefaultPerfObjectHW.restype = wintypes.DWORD
PdhGetDefaultPerfObjectHW.argtypes = [
    wintypes.HANDLE,  # hDataSource : PDH_HLOG optional
    wintypes.LPCWSTR,  # szMachineName : LPCWSTR optional
    wintypes.LPWSTR,  # szDefaultObjectName : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchBufferSize : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "pdh")]
extern "system" {
    fn PdhGetDefaultPerfObjectHW(
        hDataSource: *mut core::ffi::c_void,  // PDH_HLOG optional
        szMachineName: *const u16,  // LPCWSTR optional
        szDefaultObjectName: *mut u16,  // LPWSTR optional, out
        pcchBufferSize: *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 PdhGetDefaultPerfObjectHW(IntPtr hDataSource, [MarshalAs(UnmanagedType.LPWStr)] string szMachineName, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szDefaultObjectName, ref uint pcchBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhGetDefaultPerfObjectHW' -Namespace Win32 -PassThru
# $api::PdhGetDefaultPerfObjectHW(hDataSource, szMachineName, szDefaultObjectName, pcchBufferSize)

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

出力引数:

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