DlgDirListW function (winuser.h)
Replaces the contents of a list box with the names of the subdirectories and files in a specified directory. You can filter the list of names by specifying a set of file attributes. The list can optionally include mapped drives.
Syntax
int DlgDirListW(
[in] HWND hDlg,
[in, out] LPWSTR lpPathSpec,
[in] int nIDListBox,
[in] int nIDStaticPath,
[in] UINT uFileType
);
Parameters
[in] hDlg
Type: HWND
A handle to the dialog box that contains the list box.
[in, out] lpPathSpec
Type: LPTSTR
A pointer to a buffer containing a null-terminated string that specifies an absolute path, relative path, or filename. An absolute path can begin with a drive letter (for example, d:) or a UNC name (for example, \
machinename
sharename).
The function splits the string into a directory and a filename. The function searches the directory for names that match the filename. If the string does not specify a directory, the function searches the current directory.
If the string includes a filename, the filename must contain at least one wildcard character (? or ). If the string does not include a filename, the function behaves as if you had specified the asterisk wildcard character () as the filename. All names in the specified directory that match the filename and have the attributes specified by the uFileType parameter are added to the list box.
[in] nIDListBox
Type: int
The identifier of a list box in the hDlg dialog box. If this parameter is zero, DlgDirList does not try to fill a list box.
[in] nIDStaticPath
Type: int
The identifier of a static control in the hDlg dialog box. DlgDirList sets the text of this control to display the current drive and directory. This parameter can be zero if you do not want to display the current drive and directory.
[in] uFileType
Type: UINT
Specifies the attributes of the files or directories to be added to the list box. This parameter can be one or more of the following values.
| Value | Meaning |
|---|---|
|
Includes archived files. |
|
Includes subdirectories. Subdirectory names are enclosed in square brackets ([ ]). |
|
All mapped drives are added to the list. Drives are listed in the form [- x-], where x is the drive letter. |
|
Includes only files with the specified attributes. By default, read/write files are listed even if DDL_READWRITE is not specified. |
|
Includes hidden files. |
|
Includes read-only files. |
|
Includes read/write files with no additional attributes. This is the default setting. |
|
Includes system files. |
|
If set, DlgDirList uses the PostMessage function to send messages to the list box. If not set, DlgDirList uses the SendMessage function. |
Return value
Type: int
If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero. For example, if the string specified by lpPathSpec is not a valid path, the function fails. To get extended error information, call .
Remarks
If lpPathSpec specifies a directory, DlgDirListComboBox changes the current directory to the specified directory before filling the list box. The text of the static control identified by the nIDStaticPath parameter is set to the name of the new current directory.
DlgDirList sends the LB_RESETCONTENT and LB_DIR messages to the list box.
If uFileType includes the DDL_DIRECTORY flag and lpPathSpec specifies a first-level directory, such as C:\TEMP, the list box will always include a ".." entry for the root directory. This is true even if the root directory has hidden or system attributes and the DDL_HIDDEN and DDL_SYSTEM flags are not specified. The root directory of an NTFS volume has hidden and system attributes.
The directory listing displays long filenames, if any.
Examples
For examples, see the following topics: Creating a Directory Listing in a Single-selection List Box and Creating a Multiple-selection List Box.
Note
The winuser.h header defines DlgDirList as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | winuser.h (include Windows.h) |
| Library | User32.lib |
| DLL | User32.dll |
See also
Reference