DlgDirSelectEx function

Retrieves the current selection from a single-selection list box. It assumes that the list box has been filled by the DlgDirList function and that the selection is a drive letter, filename, or directory name.

Syntax


BOOL DlgDirSelectEx(
  _In_   HWND hDlg,
  _Out_  LPTSTR lpString,
  _In_   int nCount,
  _In_   int nIDListBox
);

Parameters

hDlg [in]

Type: HWND

A handle to the dialog box that contains the list box.

lpString [out]

Type: LPTSTR

A pointer to a buffer that receives the selected path.

nCount [in]

Type: int

The length, in TCHARs, of the buffer pointed to by lpString.

nIDListBox [in]

Type: int

The identifier of a list box in the dialog box.

Return value

Type: BOOL

If the current selection is a directory name, the return value is nonzero.

If the current selection is not a directory name, the return value is zero. To get extended error information, call GetLastError.

Remarks

The DlgDirSelectEx function copies the selection to the buffer pointed to by the lpString parameter. If the current selection is a directory name or drive letter, DlgDirSelectEx removes the enclosing square brackets (and hyphens, for drive letters), so that the name or letter is ready to be inserted into a new path. If there is no selection, lpString does not change.

If the string is as long or longer than the buffer, the buffer will contain the truncated string with a terminating null character.

DlgDirSelectEx sends LB_GETCURSEL and LB_GETTEXT messages to the list box. The function does not allow more than one filename to be returned from a list box. The list box must not be a multiple-selection list box. If it is, this function does not return a zero value and lpString remains unchanged.

Windows 95 or later: DlgDirSelectExW is supported by the Microsoft Layer for Unicode. To use this, you must add certain files to your application, as outlined in Microsoft Layer for Unicode on Windows Me/98/95 Systems.

Examples

For an example, see Creating a Directory Listing in a Single-selection List Box.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winuser.h (include Windows.h)

Library

User32.lib

DLL

User32.dll

Unicode and ANSI names

DlgDirSelectExW (Unicode) and DlgDirSelectExA (ANSI)

See also

Reference
DlgDirList
DlgDirListComboBox
DlgDirSelectComboBoxEx
LB_GETCURSEL
LB_GETTEXT

 

 

Community Additions

ADD
Show:
© 2014 Microsoft