ホーム › System.Performance › PdhEnumLogSetNamesA

PdhEnumLogSetNamesA

関数

ログセット名一覧を列挙する(ANSI版)。

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

シグネチャ

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

DWORD PdhEnumLogSetNamesA(
    LPCSTR szDataSource,
    LPSTR mszDataSetNameList,   // optional
    DWORD* pcchBufferLength
);

パラメーター

名前	型	方向	説明
szDataSource	LPCSTR	in	DSN を指定する null 終端文字列。
mszDataSetNameList	LPSTR	outoptional	null 終端のログセット名の一覧を受け取る、呼び出し側が割り当てたバッファー。一覧は null 終端文字で終了します。pcchBufferLength パラメーターが 0 の場合は NULL を設定します。
pcchBufferLength	DWORD*	inout	mszLogSetNameList バッファーのサイズ（TCHAR 単位）。入力時に 0 の場合、関数は PDH_MORE_DATA を返し、このパラメーターに必要なバッファーサイズを設定します。バッファーが必要なサイズより大きい場合、関数はこのパラメーターに実際に使用されたバッファーのサイズを設定します。入力時に指定したサイズが 0 より大きく必要なサイズより小さい場合、返されたサイズに基づいてバッファーを再割り当てしないでください。

戻り値の型: DWORD

公式ドキュメント

DSN 内のログセットの名前を列挙します。(ANSI)

戻り値

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

関数が失敗した場合の戻り値はシステムエラーコードまたは PDH エラーコードです。可能な値は次のとおりです。

戻り値	説明
PDH_MORE_DATA	mszLogSetNameList バッファーのサイズが小さすぎて、すべてのデータを格納できません。この戻り値は、入力時に pcchBufferLength が 0 の場合に想定されるものです。入力時に指定したサイズが 0 より大きく必要なサイズより小さい場合、返されたサイズに基づいてバッファーを再割り当てしないでください。
PDH_INVALID_ARGUMENT	パラメーターが無効です。たとえば、一部のリリースでは、入力時に指定したサイズが 0 より大きく必要なサイズより小さい場合に、このエラーを受け取ることがあります。

戻り値

説明

PDH_MORE_DATA

mszLogSetNameList バッファーのサイズが小さすぎて、すべてのデータを格納できません。この戻り値は、入力時に pcchBufferLength が 0 の場合に想定されるものです。入力時に指定したサイズが 0 より大きく必要なサイズより小さい場合、返されたサイズに基づいてバッファーを再割り当てしないでください。

PDH_INVALID_ARGUMENT

パラメーターが無効です。たとえば、一部のリリースでは、入力時に指定したサイズが 0 より大きく必要なサイズより小さい場合に、このエラーを受け取ることがあります。

解説(Remarks)

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

メモ

pdh.h ヘッダーは PdhEnumLogSetNames を、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 PdhEnumLogSetNamesA(
    LPCSTR szDataSource,
    LPSTR mszDataSetNameList,   // optional
    DWORD* pcchBufferLength
);

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

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

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

import ctypes
from ctypes import wintypes

PdhEnumLogSetNamesA = ctypes.windll.pdh.PdhEnumLogSetNamesA
PdhEnumLogSetNamesA.restype = wintypes.DWORD
PdhEnumLogSetNamesA.argtypes = [
    wintypes.LPCSTR,  # szDataSource : LPCSTR
    wintypes.LPSTR,  # mszDataSetNameList : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchBufferLength : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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