ホーム › System.Performance › PdhSelectDataSourceW

PdhSelectDataSourceW

関数

データソース選択ダイアログを表示して選ばせる。

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

シグネチャ

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

DWORD PdhSelectDataSourceW(
    HWND hWndOwner,
    PDH_SELECT_DATA_SOURCE_FLAGS dwFlags,
    LPWSTR szDataSource,
    DWORD* pcchBufferLength
);

パラメーター

名前

型

方向

説明

hWndOwner

HWND

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

dwFlags

PDH_SELECT_DATA_SOURCE_FLAGS

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

値

意味

PDH_FLAGS_FILE_BROWSER_ONLY

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

0

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

szDataSource

LPWSTR

inout

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

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

pcchBufferLength

DWORD*

inout

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

関数が成功した場合は、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  (Unicode / -W)
#include <windows.h>

DWORD PdhSelectDataSourceW(
    HWND hWndOwner,
    PDH_SELECT_DATA_SOURCE_FLAGS dwFlags,
    LPWSTR szDataSource,
    DWORD* pcchBufferLength
);

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

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

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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhSelectDataSourceW = Fiddle::Function.new(
  lib['PdhSelectDataSourceW'],
  [
    Fiddle::TYPE_VOIDP,  # hWndOwner : HWND
    -Fiddle::TYPE_INT,  # dwFlags : PDH_SELECT_DATA_SOURCE_FLAGS
    Fiddle::TYPE_VOIDP,  # szDataSource : LPWSTR in/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 PdhSelectDataSourceW(
        hWndOwner: *mut core::ffi::c_void,  // HWND
        dwFlags: u32,  // PDH_SELECT_DATA_SOURCE_FLAGS
        szDataSource: *mut u16,  // LPWSTR 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.Unicode)]
public static extern uint PdhSelectDataSourceW(IntPtr hWndOwner, uint dwFlags, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szDataSource, ref uint pcchBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhSelectDataSourceW' -Namespace Win32 -PassThru
# $api::PdhSelectDataSourceW(hWndOwner, dwFlags, szDataSource, pcchBufferLength)

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

出力引数:

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