EndDialog

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

This function destroys a modal dialog box, causing the system to end any processing for the dialog box.

BOOL
EndDialog( HWND
hDlg
, int
nResult
);

Parameters

hDlg

[in] Handle to the dialog box to be destroyed.

nResult

[in] Specifies the value to be returned to the application from the function that created the dialog box.

Return Values

Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

Dialog boxes created by the DialogBox, DialogBoxParam, DialogBoxIndirect, and DialogBoxIndirectParamfunctions must be destroyed using the EndDialogfunction. An application calls EndDialogfrom within the dialog box procedure; the function must not be used for any other purpose.

A dialog box procedure can call EndDialogat any time, even during the processing of the WM_INITDIALOGmessage. If your application calls the function while WM_INITDIALOG is being processed, the dialog box is destroyed before it is shown and before the input focus is set.

EndDialogdoes not destroy the dialog box immediately. Instead, it sets a flag and allows the dialog box procedure to return control to the system. The system checks the flag before attempting to retrieve the next message from the application queue. If the flag is set, the system ends the message loop, destroys the dialog box, and uses the value in nResultas the return value from the function that created the dialog box.

Requirements

Runs on	Versions	Defined in	Include	Link to
Windows CE OS	1.0 and later	Winuser.h		Dlgmgr.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.