ホーム › System.Performance › PdhSelectDataSourceA

PdhSelectDataSourceA

関数

データソース選択ダイアログを表示する(ANSI版)。

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

シグネチャ

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

DWORD PdhSelectDataSourceA(
    HWND hWndOwner,
    PDH_SELECT_DATA_SOURCE_FLAGS dwFlags,
    LPSTR szDataSource,
    DWORD* pcchBufferLength
);

パラメーター

名前

型

方向

説明

hWndOwner

HWND

ダイアログウィンドウのオーナー。オーナーが存在しない場合は NULL を指定できます(デスクトップがオーナーになります)。

dwFlags

PDH_SELECT_DATA_SOURCE_FLAGS

データソースの指定を求めるために表示されるダイアログボックス。このパラメーターには次のいずれかの値を指定できます。

値

意味

PDH_FLAGS_FILE_BROWSER_ONLY

ファイルブラウザーのみを表示します。ログファイルの名前と場所のみの指定を求めたい場合は、このフラグを設定します。

0

データソース選択ダイアログボックスを表示します。このダイアログボックスでは、ユーザーがログファイルまたはリアルタイムソースのいずれかからパフォーマンスデータを選択できます。ログファイルからデータを収集するよう指定した場合は、ログファイルの名前と場所を指定するためのファイルブラウザーが表示されます。

szDataSource

LPSTR

inout

ユーザーが選択したログファイルの名前を含む null 終端文字列を受け取る、呼び出し側で割り当てたバッファー。バッファーが小さすぎる場合、ログファイル名はバッファーのサイズに切り詰められます。

ユーザーがリアルタイムソースを選択した場合、バッファーは空になります。

pcchBufferLength

DWORD*

inout

szDataSource バッファーの最大サイズ(TCHAR 単位)。

戻り値の型: DWORD

公式ドキュメント

パフォーマンスデータのソースを指定するようユーザーに求めるダイアログウィンドウを表示します。(ANSI)

戻り値

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

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

戻り値	説明
PDH_INVALID_ARGUMENT	pcchBufferLength に渡されたバッファーの長さが、szDataSource バッファーの実際の長さと一致しません。
PDH_MEMORY_ALLOCATION_FAILURE	szDataSource パラメーターに長さ 0 のバッファーが渡されました。

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PdhSelectDataSourceA(
    HWND hWndOwner,
    PDH_SELECT_DATA_SOURCE_FLAGS dwFlags,
    LPSTR szDataSource,
    DWORD* pcchBufferLength
);

[DllImport("pdh.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint PdhSelectDataSourceA(
    IntPtr hWndOwner,   // HWND
    uint dwFlags,   // PDH_SELECT_DATA_SOURCE_FLAGS
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szDataSource,   // LPSTR in/out
    ref uint pcchBufferLength   // DWORD* in/out
);

<DllImport("pdh.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PdhSelectDataSourceA(
    hWndOwner As IntPtr,   ' HWND
    dwFlags As UInteger,   ' PDH_SELECT_DATA_SOURCE_FLAGS
    <MarshalAs(UnmanagedType.LPStr)> szDataSource As System.Text.StringBuilder,   ' LPSTR in/out
    ByRef pcchBufferLength As UInteger   ' DWORD* in/out
) As UInteger
End Function

' hWndOwner : HWND
' dwFlags : PDH_SELECT_DATA_SOURCE_FLAGS
' szDataSource : LPSTR in/out
' pcchBufferLength : DWORD* in/out
Declare PtrSafe Function PdhSelectDataSourceA Lib "pdh" ( _
    ByVal hWndOwner As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal szDataSource 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

PdhSelectDataSourceA = ctypes.windll.pdh.PdhSelectDataSourceA
PdhSelectDataSourceA.restype = wintypes.DWORD
PdhSelectDataSourceA.argtypes = [
    wintypes.HANDLE,  # hWndOwner : HWND
    wintypes.DWORD,  # dwFlags : PDH_SELECT_DATA_SOURCE_FLAGS
    wintypes.LPSTR,  # szDataSource : LPSTR in/out
    ctypes.POINTER(wintypes.DWORD),  # pcchBufferLength : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhSelectDataSourceA = Fiddle::Function.new(
  lib['PdhSelectDataSourceA'],
  [
    Fiddle::TYPE_VOIDP,  # hWndOwner : HWND
    -Fiddle::TYPE_INT,  # dwFlags : PDH_SELECT_DATA_SOURCE_FLAGS
    Fiddle::TYPE_VOIDP,  # szDataSource : LPSTR in/out
    Fiddle::TYPE_VOIDP,  # pcchBufferLength : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhSelectDataSourceA(
        hWndOwner: *mut core::ffi::c_void,  // HWND
        dwFlags: u32,  // PDH_SELECT_DATA_SOURCE_FLAGS
        szDataSource: *mut u8,  // LPSTR in/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 PdhSelectDataSourceA(IntPtr hWndOwner, uint dwFlags, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szDataSource, ref uint pcchBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhSelectDataSourceA' -Namespace Win32 -PassThru
# $api::PdhSelectDataSourceA(hWndOwner, dwFlags, szDataSource, pcchBufferLength)

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

出力引数:

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