CommDlgExtendedError

This function returns a common dialog box error value. This value indicates the most recent error to occur during the execution of one of the following common dialog box functions:

At a Glance

Header file: Commdlg.h
Windows CE versions: 2.0 and later

Syntax

DWORD CommDlgExtendedError()

Return Values

If the most recent call to a common dialog box function succeeded, the return value is undefined.

If the common dialog box function returned FALSE because the user closed or canceled the dialog box, the return value is zero. Otherwise, the return value is a nonzero error code. For more information, see the following Remarks section.

Remarks

The CommDlgExtendedError function can return general error codes for any of the common dialog box functions. In addition, there are error codes that are returned only for a specific common dialog box. The error codes returned by CommDlgExtendedError are defined in the CDERR.H file.

The following general error codes can be returned for any of the common dialog box functions:

CDERR_DIALOGFAILURE

The dialog box could not be created. The common dialog box function’s call to the DialogBox function failed. For example, this error occurs if the common dialog box call specifies an invalid window handle.

CDERR_FINDRESFAILURE

The common dialog box function failed to find a specified resource.

CDERR_INITIALIZATION

The common dialog box function failed during initialization. This error often occurs when sufficient memory is not available.

CDERR_LOADRESFAILURE

The common dialog box function failed to load a specified resource.

CDERR_LOADSTRFAILURE

The common dialog box function failed to load a specified string.

CDERR_LOCKRESFAILURE

The common dialog box function failed to lock a specified resource.

CDERR_MEMALLOCFAILURE

The common dialog box function was unable to allocate memory for internal structures.

CDERR_NOHINSTANCE

The ENABLETEMPLATE flag was set in the Flags member of the initialization structure for the corresponding common dialog box, but you failed to provide a corresponding instance handle.

CDERR_NOHOOK

The ENABLEHOOK flag was set in the Flags member of the initialization structure for the corresponding common dialog box, but you failed to provide a pointer to a corresponding hook procedure.

CDERR_NOTEMPLATE

The ENABLETEMPLATE flag was set in the Flags member of the initialization structure for the corresponding common dialog box, but you failed to provide a corresponding template.

CDERR_REGISTRYFAILURE

The common dialog box function was unable to read from registry.

CDERR_STRUCTSIZE

The lStructSize member of the initialization structure for the corresponding common dialog box is invalid.

The following error codes can be returned for the PrintDlg function:

PDERR_CREATEDCFAILURE

The call to CreateDC failed.

PDERR_NOPORTS

No ports are registered.

PDERR_NOPRINTERS

No printers are registered.

PDERR_PARSEFAILURE

The PrintDlg function failed to parse the strings in the [devices] section of the WIN.INI file.

PDERR_PRINTERNOTFOUND

The [devices] section of the WIN.INI file did not contain an entry for the requested printer.

PDERR_RETDEFFAILURE

The PD_RETURNDEFAULT flag was specified in the Flags member of the PRINTDLG structure, but the hDevMode or hDevNames member was not NULL.

PDERR_SETUPFAILURE

The PrintDlg function failed to load the required resources.

The following error codes can be returned for the GetOpenFileName and GetSaveFileName functions:

FNERR_BUFFERTOOSMALL

The buffer pointed to by the lpstrFile member of the OPENFILENAME structure is too small for the filename specified by the user. The first two bytes of the lpstrFile buffer contain an integer value specifying the size, in bytes (ANSI version) or 16-bit characters (Unicode version), required to receive the full name.

FNERR_INVALIDFILENAME

A filename is invalid.

FNERR_SUBCLASSFAILURE

An attempt to subclass a list box failed because sufficient memory was not available.