ホーム › System.Performance › PdhEnumLogSetNamesW

PdhEnumLogSetNamesW

関数

SQLデータソース内のログセット名一覧を列挙する。

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

シグネチャ

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

DWORD PdhEnumLogSetNamesW(
    LPCWSTR szDataSource,
    LPWSTR mszDataSetNameList,   // optional
    DWORD* pcchBufferLength
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

[DllImport("pdh.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PdhEnumLogSetNamesW(
    [MarshalAs(UnmanagedType.LPWStr)] string szDataSource,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszDataSetNameList,   // LPWSTR optional, out
    ref uint pcchBufferLength   // DWORD* in/out
);

<DllImport("pdh.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PdhEnumLogSetNamesW(
    <MarshalAs(UnmanagedType.LPWStr)> szDataSource As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> mszDataSetNameList As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcchBufferLength As UInteger   ' DWORD* in/out
) As UInteger
End Function

' szDataSource : LPCWSTR
' mszDataSetNameList : LPWSTR optional, out
' pcchBufferLength : DWORD* in/out
Declare PtrSafe Function PdhEnumLogSetNamesW Lib "pdh" ( _
    ByVal szDataSource As LongPtr, _
    ByVal mszDataSetNameList As LongPtr, _
    ByRef pcchBufferLength 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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "pdh")]
extern "system" {
    fn PdhEnumLogSetNamesW(
        szDataSource: *const u16,  // LPCWSTR
        mszDataSetNameList: *mut u16,  // LPWSTR 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.Unicode)]
public static extern uint PdhEnumLogSetNamesW([MarshalAs(UnmanagedType.LPWStr)] string szDataSource, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder mszDataSetNameList, ref uint pcchBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhEnumLogSetNamesW' -Namespace Win32 -PassThru
# $api::PdhEnumLogSetNamesW(szDataSource, mszDataSetNameList, pcchBufferLength)

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

出力引数:

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