CommDlgExtendedError

  • Article

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:

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 functions 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_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_PRINTERNOTFOUND
    The [devices] section of the WIN.INI file did not contain an entry for the requested printer.

Requirements

Runs On Versions Defined in Include Link to
Windows CE OS 2.0 and later Commctrl.h   Commdlg.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

DialogBox, PrintDlg

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.