ホーム › UI.Controls › DlgDirSelectComboBoxExW

DlgDirSelectComboBoxExW

関数

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

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

シグネチャ

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

BOOL DlgDirSelectComboBoxExW(
    HWND hwndDlg,
    LPWSTR lpString,
    INT cchOut,
    INT idComboBox
);

パラメーター

名前	型	方向	説明
hwndDlg	HWND	in	コンボボックスを含むダイアログボックスへのハンドル。
lpString	LPWSTR	out	選択されたパスを受け取るバッファーへのポインター。
cchOut	INT	in	lpString パラメーターが指すバッファーの長さ(文字数)。
idComboBox	INT	in	ダイアログボックス内のコンボボックスコントロールの整数識別子。

戻り値の型: BOOL

公式ドキュメント

DlgDirListComboBox 関数で内容が設定されたコンボボックスから現在の選択項目を取得します。選択項目はドライブ文字、ファイル、またはディレクトリ名として解釈されます。(Unicode)

戻り値

型: BOOL

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

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

解説(Remarks)

現在の選択項目がディレクトリ名またはドライブ文字を指定している場合、DlgDirSelectComboBoxEx 関数は、囲んでいる角括弧(およびドライブ文字のハイフン)を取り除き、その名前または文字をそのまま新しいパスやファイル名に挿入できる状態にします。選択項目がない場合、lpString が指すバッファーの内容は変更されません。

DlgDirSelectComboBoxEx 関数では、コンボボックスから複数のファイル名を返すことはできません。

文字列がバッファーと同じ長さ、またはそれより長い場合、バッファーには末尾に null 文字が付いた切り詰められた文字列が格納されます。

DlgDirSelectComboBoxEx は、コンボボックスに CB_GETCURSEL および CB_GETLBTEXT メッセージを送信します。

この関数は、3 種類すべてのコンボボックス(CBS_SIMPLE、CBS_DROPDOWN、CBS_DROPDOWNLIST)で使用できます。

セキュリティに関する警告: この関数を不適切に使用すると、アプリケーションに問題が生じる可能性があります。たとえば、nCount パラメーターは ANSI 版と Unicode 版の両方で適切に設定する必要があります。これを怠ると、バッファーオーバーフローを引き起こす可能性があります。続行する前に、Security Considerations: Microsoft Windows Controls を確認してください。

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

メモ

winuser.h ヘッダーは DlgDirSelectComboBoxEx を、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 DlgDirSelectComboBoxExW(
    HWND hwndDlg,
    LPWSTR lpString,
    INT cchOut,
    INT idComboBox
);

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

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

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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "user32")]
extern "system" {
    fn DlgDirSelectComboBoxExW(
        hwndDlg: *mut core::ffi::c_void,  // HWND
        lpString: *mut u16,  // LPWSTR out
        cchOut: i32,  // INT
        idComboBox: 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 DlgDirSelectComboBoxExW(IntPtr hwndDlg, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpString, int cchOut, int idComboBox);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DlgDirSelectComboBoxExW' -Namespace Win32 -PassThru
# $api::DlgDirSelectComboBoxExW(hwndDlg, lpString, cchOut, idComboBox)

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

出力引数:

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