DlgDirListW

関数

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

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

シグネチャ

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

INT DlgDirListW(
    HWND hDlg,
    LPWSTR lpPathSpec,
    INT nIDListBox,
    INT nIDStaticPath,
    DLG_DIR_LIST_FILE_TYPE uFileType
);

パラメーター

名前型方向説明

hDlg HWND in リストボックスを含むダイアログボックスへのハンドルです。

lpPathSpec

LPWSTR

inout

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

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

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

nIDListBox

INT

                <i>hDlg</i> ダイアログボックス内のリストボックスの識別子です。このパラメーターが 0 の場合、<b>DlgDirList</b> はリストボックスを埋めようとしません。

nIDStaticPath

INT

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

uFileType

DLG_DIR_LIST_FILE_TYPE

リストボックスに追加するファイルまたはディレクトリの属性を指定します。このパラメーターには、次の値のうち 1 つ以上を指定できます。

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

戻り値の型: INT

公式ドキュメント

リストボックスの内容を、指定したディレクトリ内のサブディレクトリおよびファイルの名前で置き換えます。一連のファイル属性を指定することで、名前の一覧をフィルター処理できます。一覧には、マップされたドライブを含めることもできます。(Unicode)

戻り値

型: int

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

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

解説(Remarks)

            <i>lpPathSpec</i> がディレクトリを指定している場合、<a href="/windows/desktop/api/winuser/nf-winuser-dlgdirlistcomboboxa">DlgDirListComboBox</a> はリストボックスを埋める前に、カレントディレクトリを指定したディレクトリに変更します。
            <i>nIDStaticPath</i> パラメーターで識別されるスタティックコントロールのテキストは、新しいカレントディレクトリの名前に設定されます。

DlgDirList は、リストボックスに LB_RESETCONTENT メッセージと LB_DIR メッセージを送信します。

            <i>uFileType</i> に DDL_DIRECTORY フラグが含まれており、
            <i>lpPathSpec</i> が C:\TEMP のような第 1 レベルのディレクトリを指定している場合、リストボックスには常にルートディレクトリを表す ".." エントリが含まれます。これは、ルートディレクトリが隠し属性またはシステム属性を持ち、DDL_HIDDEN フラグや DDL_SYSTEM フラグが指定されていない場合でも当てはまります。NTFS ボリュームのルートディレクトリは、隠し属性とシステム属性を持ちます。

ディレクトリの一覧には、長いファイル名がある場合はそれが表示されます。

例

例については、次のトピックを参照してください: 単一選択リストボックスでのディレクトリ一覧の作成および複数選択リストボックスの作成。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 DlgDirListW(
    HWND hDlg,
    LPWSTR lpPathSpec,
    INT nIDListBox,
    INT nIDStaticPath,
    DLG_DIR_LIST_FILE_TYPE uFileType
);

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

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function DlgDirListW(
    hDlg As IntPtr,   ' HWND
    <MarshalAs(UnmanagedType.LPWStr)> lpPathSpec As System.Text.StringBuilder,   ' LPWSTR in/out
    nIDListBox 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
' nIDListBox : INT
' nIDStaticPath : INT
' uFileType : DLG_DIR_LIST_FILE_TYPE
Declare PtrSafe Function DlgDirListW Lib "user32" ( _
    ByVal hDlg As LongPtr, _
    ByVal lpPathSpec As LongPtr, _
    ByVal nIDListBox 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

DlgDirListW = ctypes.windll.user32.DlgDirListW
DlgDirListW.restype = ctypes.c_int
DlgDirListW.argtypes = [
    wintypes.HANDLE,  # hDlg : HWND
    wintypes.LPWSTR,  # lpPathSpec : LPWSTR in/out
    ctypes.c_int,  # nIDListBox : INT
    ctypes.c_int,  # nIDStaticPath : INT
    wintypes.DWORD,  # uFileType : DLG_DIR_LIST_FILE_TYPE
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
DlgDirListW = Fiddle::Function.new(
  lib['DlgDirListW'],
  [
    Fiddle::TYPE_VOIDP,  # hDlg : HWND
    Fiddle::TYPE_VOIDP,  # lpPathSpec : LPWSTR in/out
    Fiddle::TYPE_INT,  # nIDListBox : 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 DlgDirListW(
        hDlg: *mut core::ffi::c_void,  // HWND
        lpPathSpec: *mut u16,  // LPWSTR in/out
        nIDListBox: 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)]
public static extern int DlgDirListW(IntPtr hDlg, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpPathSpec, int nIDListBox, int nIDStaticPath, uint uFileType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DlgDirListW' -Namespace Win32 -PassThru
# $api::DlgDirListW(hDlg, lpPathSpec, nIDListBox, nIDStaticPath, uFileType)

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

出力引数:

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