CDM_GETFILEPATH message

[Starting with Windows Vista, the Open and Save As common dialog boxes have been superseded by the Common Item Dialog. We recommended that you use the Common Item Dialog API instead of these dialog boxes from the Common Dialog Box Library.]

Retrieves the path and file name of the selected file in an Explorer-style Open or Save As dialog box. The dialog box must have been created with the OFN_EXPLORER flag; otherwise, the message fails.

#define WM_USER                  0x0400
#define CDM_FIRST               (WM_USER + 100)
#define CDM_GETFILEPATH         (CDM_FIRST + 0x0001)

Parameters

wParam

The size, in characters, of the lParam buffer. For the ANSI version, this is the number of bytes; for the Unicode version, this is the number of characters.

lParam

A pointer to the buffer that receives the file name and path.

Return value

If the message succeeds, the return value is the size, in characters, of the file name and path string, including the terminating NULL character. This is either the number of bytes or characters copied to the buffer, or the required buffer size if the buffer is too small.

If an error occurs, the return value is less than zero.

Remarks

The corresponding macro is as follows:

int CommDlg_OpenSave_GetFilePath(hwnd, lparam, wparam); 

Requirements

Requirement Value
Minimum supported client
Windows 2000 Professional [desktop apps only]
Minimum supported server
Windows 2000 Server [desktop apps only]
Header
Commdlg.h (include Windows.h)

See also

Reference

GetOpenFileName

GetSaveFileName

OPENFILENAME

Conceptual

Common Dialog Box Library