ホーム › System.Performance › PdhGetDefaultPerfObjectA

PdhGetDefaultPerfObjectA

関数

既定パフォーマンスオブジェクト名を取得する(ANSI版)。

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

シグネチャ

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

DWORD PdhGetDefaultPerfObjectA(
    LPCSTR szDataSource,   // optional
    LPCSTR szMachineName,   // optional
    LPSTR szDefaultObjectName,   // optional
    DWORD* pcchBufferSize
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

関数が成功した場合、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 ヘッダーは、PdhGetDefaultPerfObject を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在して使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規約を参照してください。

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

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

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

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

import ctypes
from ctypes import wintypes

PdhGetDefaultPerfObjectA = ctypes.windll.pdh.PdhGetDefaultPerfObjectA
PdhGetDefaultPerfObjectA.restype = wintypes.DWORD
PdhGetDefaultPerfObjectA.argtypes = [
    wintypes.LPCSTR,  # szDataSource : LPCSTR optional
    wintypes.LPCSTR,  # szMachineName : LPCSTR optional
    wintypes.LPSTR,  # szDefaultObjectName : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchBufferSize : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhGetDefaultPerfObjectA = Fiddle::Function.new(
  lib['PdhGetDefaultPerfObjectA'],
  [
    Fiddle::TYPE_VOIDP,  # szDataSource : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # szMachineName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # szDefaultObjectName : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchBufferSize : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

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

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

出力引数:

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