ホーム › System.Performance › PdhGetDefaultPerfObjectW

PdhGetDefaultPerfObjectW

関数

データソースの既定パフォーマンスオブジェクト名を取得する。

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

シグネチャ

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

DWORD PdhGetDefaultPerfObjectW(
    LPCWSTR szDataSource,   // optional
    LPCWSTR szMachineName,   // optional
    LPWSTR szDefaultObjectName,   // optional
    DWORD* pcchBufferSize
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

デフォルトのオブジェクト名を取得します。この名前は、カウンターの参照ダイアログボックスで初期オブジェクトの選択を設定するために使用できます。データソースへのハンドルを使用するには、PdhGetDefaultPerfObjectH 関数を使用してください。(Unicode)

戻り値

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

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

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

解説(Remarks)

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

メモ

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

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

[DllImport("pdh.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PdhGetDefaultPerfObjectW(
    [MarshalAs(UnmanagedType.LPWStr)] string szDataSource,   // LPCWSTR 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 PdhGetDefaultPerfObjectW(
    <MarshalAs(UnmanagedType.LPWStr)> szDataSource As String,   ' LPCWSTR 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

' szDataSource : LPCWSTR optional
' szMachineName : LPCWSTR optional
' szDefaultObjectName : LPWSTR optional, out
' pcchBufferSize : DWORD* in/out
Declare PtrSafe Function PdhGetDefaultPerfObjectW Lib "pdh" ( _
    ByVal szDataSource 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

PdhGetDefaultPerfObjectW = ctypes.windll.pdh.PdhGetDefaultPerfObjectW
PdhGetDefaultPerfObjectW.restype = wintypes.DWORD
PdhGetDefaultPerfObjectW.argtypes = [
    wintypes.LPCWSTR,  # szDataSource : LPCWSTR 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')
PdhGetDefaultPerfObjectW = Fiddle::Function.new(
  lib['PdhGetDefaultPerfObjectW'],
  [
    Fiddle::TYPE_VOIDP,  # szDataSource : LPCWSTR 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 PdhGetDefaultPerfObjectW(
        szDataSource: *const u16,  // LPCWSTR 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 PdhGetDefaultPerfObjectW([MarshalAs(UnmanagedType.LPWStr)] string szDataSource, [MarshalAs(UnmanagedType.LPWStr)] string szMachineName, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szDefaultObjectName, ref uint pcchBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhGetDefaultPerfObjectW' -Namespace Win32 -PassThru
# $api::PdhGetDefaultPerfObjectW(szDataSource, szMachineName, szDefaultObjectName, pcchBufferSize)

#uselib "pdh.dll"
#func global PdhGetDefaultPerfObjectW "PdhGetDefaultPerfObjectW" wptr, wptr, wptr, wptr
; PdhGetDefaultPerfObjectW szDataSource, szMachineName, varptr(szDefaultObjectName), varptr(pcchBufferSize)   ; 戻り値は stat
; szDataSource : LPCWSTR 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 PdhGetDefaultPerfObjectW "PdhGetDefaultPerfObjectW" wstr, wstr, var, var
; res = PdhGetDefaultPerfObjectW(szDataSource, szMachineName, szDefaultObjectName, pcchBufferSize)
; szDataSource : LPCWSTR optional -> "wstr"
; szMachineName : LPCWSTR optional -> "wstr"
; szDefaultObjectName : LPWSTR optional, out -> "var"
; pcchBufferSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "pdh.dll"
#cfunc global PdhGetDefaultPerfObjectW "PdhGetDefaultPerfObjectW" wstr, wstr, sptr, sptr
; res = PdhGetDefaultPerfObjectW(szDataSource, szMachineName, varptr(szDefaultObjectName), varptr(pcchBufferSize))
; szDataSource : LPCWSTR optional -> "wstr"
; szMachineName : LPCWSTR optional -> "wstr"
; szDefaultObjectName : LPWSTR optional, out -> "sptr"
; pcchBufferSize : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。