DlgDirListComboBoxW

関数

ディレクトリ内容をダイアログのコンボボックスに一覧表示する(Unicode版)。

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

シグネチャ

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

INT DlgDirListComboBoxW(
    HWND hDlg,
    LPWSTR lpPathSpec,
    INT nIDComboBox,
    INT nIDStaticPath,
    DLG_DIR_LIST_FILE_TYPE uFiletype
);

パラメーター

名前

型

方向

説明

hDlg

HWND

コンボボックスを含むダイアログボックスへのハンドルです。

lpPathSpec

LPWSTR

inout

絶対パス、相対パス、またはファイル名を指定する null 終端文字列を格納したバッファーへのポインターです。絶対パスは、ドライブ文字(例: d:\)または UNC 名(例: \\machinename\sharename)で始めることができます。

この関数は文字列をディレクトリとファイル名に分割します。関数はそのディレクトリ内で、ファイル名に一致する名前を検索します。文字列がディレクトリを指定していない場合、関数は現在のディレクトリを検索します。

文字列にファイル名が含まれる場合、そのファイル名には少なくとも 1 つのワイルドカード文字(? または *)を含める必要があります。文字列にファイル名が含まれない場合、関数はファイル名としてアスタリスクのワイルドカード文字(*)が指定されたものとして動作します。指定されたディレクトリ内で、ファイル名に一致し、かつ uFiletype パラメーターで指定された属性を持つすべての名前が、コンボボックスに表示される一覧に追加されます。

nIDComboBox

INT

hDlg ダイアログボックス内のコンボボックスの識別子です。このパラメーターが 0 の場合、DlgDirListComboBox はコンボボックスへの設定を試みません。

nIDStaticPath

INT

hDlg ダイアログボックス内のスタティックコントロールの識別子です。DlgDirListComboBox は、現在のドライブとディレクトリを表示するようにこのコントロールのテキストを設定します。現在のドライブとディレクトリを表示したくない場合、このパラメーターは 0 にできます。

uFiletype

DLG_DIR_LIST_FILE_TYPE

コンボボックスに追加するファイルまたはディレクトリの属性を指定するビットフラグのセットです。このパラメーターには、次の値の組み合わせを指定できます。

値	意味
DDL_ARCHIVE	アーカイブ属性のファイルを含めます。
DDL_DIRECTORY	サブディレクトリを含めます。サブディレクトリは角かっこ([ ])で囲まれます。
DDL_DRIVES	割り当て済みのすべてのドライブが一覧に追加されます。ドライブは [-x-] の形式で一覧表示されます。ここで x はドライブ文字です。
DDL_EXCLUSIVE	指定した属性を持つファイルのみを含めます。既定では、DDL_READWRITE が指定されていなくても読み取り/書き込みファイルが一覧表示されます。
DDL_HIDDEN	隠しファイルを含めます。
DDL_READONLY	読み取り専用ファイルを含めます。
DDL_READWRITE	追加の属性を持たない読み取り/書き込みファイルを含めます。これが既定の設定です。
DDL_SYSTEM	システムファイルを含めます。
DDL_POSTMSGS	このフラグが設定されている場合、DlgDirListComboBox は PostMessage 関数を使用してコンボボックスにメッセージを送信します。このフラグが設定されていない場合、DlgDirListComboBox は SendMessage 関数を使用します。

戻り値の型: INT

公式ドキュメント

コンボボックスの内容を、指定したディレクトリ内のサブディレクトリ名とファイル名で置き換えます。ファイル属性のセットを指定することで、名前の一覧をフィルタリングできます。名前の一覧には、割り当て済みのドライブ文字を含めることができます。(Unicode)

戻り値

型: int

関数が成功した場合、戻り値は 0 以外になります。

関数が失敗した場合、戻り値は 0 になります。たとえば、lpPathSpec で指定された文字列が有効なパスでない場合、関数は失敗します。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

lpPathSpec がディレクトリを指定している場合、DlgDirListComboBox はコンボボックスに設定する前に、現在のディレクトリを指定されたディレクトリに変更します。nIDStaticPath パラメーターで識別されるスタティックコントロールのテキストは、新しい現在のディレクトリの名前に設定されます。

DlgDirListComboBox は、CB_RESETCONTENT メッセージと CB_DIR メッセージをコンボボックスに送信します。

Microsoft Windows NT 4.0 以降: uFiletype に DDL_DIRECTORY フラグが含まれており、かつ lpPathSpec が C:\TEMP のような第 1 レベルのディレクトリを指定している場合、コンボボックスには常にルートディレクトリを表す ".." エントリが含まれます。これは、ルートディレクトリに隠し属性やシステム属性があり、DDL_HIDDEN フラグや DDL_SYSTEM フラグが指定されていない場合でも同様です。NTFS ボリュームのルートディレクトリには、隠し属性とシステム属性があります。

セキュリティに関する警告: この関数を誤って使用すると、プログラムのセキュリティが損なわれる可能性があります。この関数の誤った使用には、lpPathSpec が書き込み不可のバッファーや null 終端のないバッファーを指すようにすることが含まれます。続行する前に、セキュリティに関する考慮事項: Microsoft Windows コントロールを確認してください。

Microsoft Windows NT 4.0 以降: 一覧には長いファイル名が表示されます(ある場合)。

Windows 95 以降: 一覧には短いファイル名(8.3 形式)が表示されます。対応する長いファイル名を取得するには、SHGetFileInfo 関数または GetFullPathName 関数を使用できます。

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

メモ

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして DlgDirListComboBox を定義します。エンコード非依存のエイリアスの使用を、エンコード非依存でないコードと混在させると、不整合が生じ、コンパイルエラーや実行時エラーが発生する可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

INT DlgDirListComboBoxW(
    HWND hDlg,
    LPWSTR lpPathSpec,
    INT nIDComboBox,
    INT nIDStaticPath,
    DLG_DIR_LIST_FILE_TYPE uFiletype
);

[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int DlgDirListComboBoxW(
    IntPtr hDlg,   // HWND
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpPathSpec,   // LPWSTR in/out
    int nIDComboBox,   // INT
    int nIDStaticPath,   // INT
    uint uFiletype   // DLG_DIR_LIST_FILE_TYPE
);

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DlgDirListComboBoxW(
    hDlg As IntPtr,   ' HWND
    <MarshalAs(UnmanagedType.LPWStr)> lpPathSpec As System.Text.StringBuilder,   ' LPWSTR in/out
    nIDComboBox As Integer,   ' INT
    nIDStaticPath As Integer,   ' INT
    uFiletype As UInteger   ' DLG_DIR_LIST_FILE_TYPE
) As Integer
End Function

' hDlg : HWND
' lpPathSpec : LPWSTR in/out
' nIDComboBox : INT
' nIDStaticPath : INT
' uFiletype : DLG_DIR_LIST_FILE_TYPE
Declare PtrSafe Function DlgDirListComboBoxW Lib "user32" ( _
    ByVal hDlg As LongPtr, _
    ByVal lpPathSpec As LongPtr, _
    ByVal nIDComboBox As Long, _
    ByVal nIDStaticPath As Long, _
    ByVal uFiletype 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

DlgDirListComboBoxW = ctypes.windll.user32.DlgDirListComboBoxW
DlgDirListComboBoxW.restype = ctypes.c_int
DlgDirListComboBoxW.argtypes = [
    wintypes.HANDLE,  # hDlg : HWND
    wintypes.LPWSTR,  # lpPathSpec : LPWSTR in/out
    ctypes.c_int,  # nIDComboBox : INT
    ctypes.c_int,  # nIDStaticPath : INT
    wintypes.DWORD,  # uFiletype : DLG_DIR_LIST_FILE_TYPE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
DlgDirListComboBoxW = Fiddle::Function.new(
  lib['DlgDirListComboBoxW'],
  [
    Fiddle::TYPE_VOIDP,  # hDlg : HWND
    Fiddle::TYPE_VOIDP,  # lpPathSpec : LPWSTR in/out
    Fiddle::TYPE_INT,  # nIDComboBox : INT
    Fiddle::TYPE_INT,  # nIDStaticPath : INT
    -Fiddle::TYPE_INT,  # uFiletype : DLG_DIR_LIST_FILE_TYPE
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn DlgDirListComboBoxW(
        hDlg: *mut core::ffi::c_void,  // HWND
        lpPathSpec: *mut u16,  // LPWSTR in/out
        nIDComboBox: i32,  // INT
        nIDStaticPath: i32,  // INT
        uFiletype: u32  // DLG_DIR_LIST_FILE_TYPE
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern int DlgDirListComboBoxW(IntPtr hDlg, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpPathSpec, int nIDComboBox, int nIDStaticPath, uint uFiletype);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DlgDirListComboBoxW' -Namespace Win32 -PassThru
# $api::DlgDirListComboBoxW(hDlg, lpPathSpec, nIDComboBox, nIDStaticPath, uFiletype)

#uselib "USER32.dll"
#func global DlgDirListComboBoxW "DlgDirListComboBoxW" wptr, wptr, wptr, wptr, wptr
; DlgDirListComboBoxW hDlg, varptr(lpPathSpec), nIDComboBox, nIDStaticPath, uFiletype   ; 戻り値は stat
; hDlg : HWND -> "wptr"
; lpPathSpec : LPWSTR in/out -> "wptr"
; nIDComboBox : INT -> "wptr"
; nIDStaticPath : INT -> "wptr"
; uFiletype : DLG_DIR_LIST_FILE_TYPE -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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