DlgDirListA

関数

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

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

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

INT DlgDirListA(
    HWND hDlg,
    LPSTR lpPathSpec,
    INT nIDListBox,
    INT nIDStaticPath,
    DLG_DIR_LIST_FILE_TYPE uFileType
);

パラメーター

名前

型

方向

説明

hDlg

HWND

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

lpPathSpec

LPSTR

inout

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

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

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

nIDListBox

INT

hDlg ダイアログボックス内のリストボックスの識別子です。このパラメーターが 0 の場合、DlgDirList はリストボックスへの設定を行いません。

nIDStaticPath

INT

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

公式ドキュメント

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

戻り値

型: int

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

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

解説(Remarks)

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

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

uFileType に DDL_DIRECTORY フラグが含まれ、かつ lpPathSpec が 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  (ANSI / -A)
#include <windows.h>

INT DlgDirListA(
    HWND hDlg,
    LPSTR lpPathSpec,
    INT nIDListBox,
    INT nIDStaticPath,
    DLG_DIR_LIST_FILE_TYPE uFileType
);

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

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function DlgDirListA(
    hDlg As IntPtr,   ' HWND
    <MarshalAs(UnmanagedType.LPStr)> lpPathSpec As System.Text.StringBuilder,   ' LPSTR 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 : LPSTR in/out
' nIDListBox : INT
' nIDStaticPath : INT
' uFileType : DLG_DIR_LIST_FILE_TYPE
Declare PtrSafe Function DlgDirListA Lib "user32" ( _
    ByVal hDlg As LongPtr, _
    ByVal lpPathSpec As String, _
    ByVal nIDListBox As Long, _
    ByVal nIDStaticPath As Long, _
    ByVal uFileType As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DlgDirListA = ctypes.windll.user32.DlgDirListA
DlgDirListA.restype = ctypes.c_int
DlgDirListA.argtypes = [
    wintypes.HANDLE,  # hDlg : HWND
    wintypes.LPSTR,  # lpPathSpec : LPSTR 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')
DlgDirListA = Fiddle::Function.new(
  lib['DlgDirListA'],
  [
    Fiddle::TYPE_VOIDP,  # hDlg : HWND
    Fiddle::TYPE_VOIDP,  # lpPathSpec : LPSTR in/out
    Fiddle::TYPE_INT,  # nIDListBox : INT
    Fiddle::TYPE_INT,  # nIDStaticPath : INT
    -Fiddle::TYPE_INT,  # uFileType : DLG_DIR_LIST_FILE_TYPE
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn DlgDirListA(
        hDlg: *mut core::ffi::c_void,  // HWND
        lpPathSpec: *mut u8,  // LPSTR 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.Ansi)]
public static extern int DlgDirListA(IntPtr hDlg, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpPathSpec, int nIDListBox, int nIDStaticPath, uint uFileType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DlgDirListA' -Namespace Win32 -PassThru
# $api::DlgDirListA(hDlg, lpPathSpec, nIDListBox, nIDStaticPath, uFileType)

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

出力引数:

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