DlgDirSelectExW

関数

リストボックスで選択中のファイルやディレクトリ名を取得する(Unicode版)。

DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL DlgDirSelectExW(
    HWND hwndDlg,
    LPWSTR lpString,
    INT chCount,
    INT idListBox
);

パラメーター

名前	型	方向	説明
hwndDlg	HWND	in	リストボックスを含むダイアログボックスへのハンドルです。
lpString	LPWSTR	out	選択されたパスを受け取るバッファへのポインターです。
chCount	INT	in	lpString が指すバッファの長さ（ TCHAR 単位）です。
idListBox	INT	in	ダイアログボックス内のリストボックスの識別子です。

戻り値の型: BOOL

公式ドキュメント

単一選択リストボックスから現在の選択項目を取得します。リストボックスは DlgDirList 関数によって設定されており、選択項目がドライブ文字、ファイル名、またはディレクトリ名であることを前提とします。(Unicode)

戻り値

型: BOOL

現在の選択項目がディレクトリ名である場合、戻り値は 0 以外になります。

現在の選択項目がディレクトリ名でない場合、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

DlgDirSelectEx 関数は、選択項目を lpString パラメーターが指すバッファにコピーします。現在の選択項目がディレクトリ名またはドライブ文字の場合、DlgDirSelectEx は囲んでいる角かっこ（およびドライブ文字の場合はハイフン）を取り除き、名前または文字を新しいパスにそのまま挿入できる状態にします。選択項目が存在しない場合、 lpString は変更されません。文字列がバッファと同じ長さ以上の場合、バッファには終端 null 文字を付加した切り詰められた文字列が格納されます。

DlgDirSelectEx は、リストボックスに LB_GETCURSEL および LB_GETTEXT メッセージを送信します。この関数は、リストボックスから複数のファイル名を返すことはできません。リストボックスは複数選択リストボックスであってはなりません。複数選択リストボックスの場合、この関数は 0 以外の値を返さず、 lpString は変更されません。

Windows 95 以降: DlgDirSelectExW は Microsoft Layer for Unicode によってサポートされます。これを使用するには、Microsoft Layer for Unicode on Windows Me/98/95 Systems に記載されているとおり、特定のファイルをアプリケーションに追加する必要があります。

例

例については、Creating a Directory Listing in a Single-selection List Box を参照してください。

メモ

winuser.h ヘッダーは DlgDirSelectEx をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードを混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL DlgDirSelectExW(
    HWND hwndDlg,
    LPWSTR lpString,
    INT chCount,
    INT idListBox
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool DlgDirSelectExW(
    IntPtr hwndDlg,   // HWND
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpString,   // LPWSTR out
    int chCount,   // INT
    int idListBox   // INT
);

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DlgDirSelectExW(
    hwndDlg As IntPtr,   ' HWND
    <MarshalAs(UnmanagedType.LPWStr)> lpString As System.Text.StringBuilder,   ' LPWSTR out
    chCount As Integer,   ' INT
    idListBox As Integer   ' INT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hwndDlg : HWND
' lpString : LPWSTR out
' chCount : INT
' idListBox : INT
Declare PtrSafe Function DlgDirSelectExW Lib "user32" ( _
    ByVal hwndDlg As LongPtr, _
    ByVal lpString As LongPtr, _
    ByVal chCount As Long, _
    ByVal idListBox 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

DlgDirSelectExW = ctypes.windll.user32.DlgDirSelectExW
DlgDirSelectExW.restype = wintypes.BOOL
DlgDirSelectExW.argtypes = [
    wintypes.HANDLE,  # hwndDlg : HWND
    wintypes.LPWSTR,  # lpString : LPWSTR out
    ctypes.c_int,  # chCount : INT
    ctypes.c_int,  # idListBox : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
DlgDirSelectExW = Fiddle::Function.new(
  lib['DlgDirSelectExW'],
  [
    Fiddle::TYPE_VOIDP,  # hwndDlg : HWND
    Fiddle::TYPE_VOIDP,  # lpString : LPWSTR out
    Fiddle::TYPE_INT,  # chCount : INT
    Fiddle::TYPE_INT,  # idListBox : INT
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn DlgDirSelectExW(
        hwndDlg: *mut core::ffi::c_void,  // HWND
        lpString: *mut u16,  // LPWSTR out
        chCount: i32,  // INT
        idListBox: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool DlgDirSelectExW(IntPtr hwndDlg, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpString, int chCount, int idListBox);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DlgDirSelectExW' -Namespace Win32 -PassThru
# $api::DlgDirSelectExW(hwndDlg, lpString, chCount, idListBox)

#uselib "USER32.dll"
#func global DlgDirSelectExW "DlgDirSelectExW" wptr, wptr, wptr, wptr
; DlgDirSelectExW hwndDlg, varptr(lpString), chCount, idListBox   ; 戻り値は stat
; hwndDlg : HWND -> "wptr"
; lpString : LPWSTR out -> "wptr"
; chCount : INT -> "wptr"
; idListBox : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global DlgDirSelectExW "DlgDirSelectExW" sptr, var, int, int
; res = DlgDirSelectExW(hwndDlg, lpString, chCount, idListBox)
; hwndDlg : HWND -> "sptr"
; lpString : LPWSTR out -> "var"
; chCount : INT -> "int"
; idListBox : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global DlgDirSelectExW "DlgDirSelectExW" sptr, sptr, int, int
; res = DlgDirSelectExW(hwndDlg, varptr(lpString), chCount, idListBox)
; hwndDlg : HWND -> "sptr"
; lpString : LPWSTR out -> "sptr"
; chCount : INT -> "int"
; idListBox : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。