windows_programming_notes.nbk: Home | Index | Next Page: Examining a Message Queue | Previous Page: EndDeferWindowPos

EndDialog

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

Syntax

    BOOL EndDialog(
        HWND hDlg,
        INT_PTR nResult
    );

Parameters

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

Return Value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

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

A dialog box procedure can call EndDialog at any time, even during the processing of the WM_INITDIALOG message. 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.

EndDialog does 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 nResult as the return value from the function that created the dialog box.

Function Information

Minimum DLL Version user32.dll
Header Declared in Winuser.h, include Windows.h
Import library User32.lib
Minimum operating systems Windows 95, Windows NT 3.1
Unicode Implemented as Unicode version.

windows_programming_notes.nbk: Home | Index | Next Page: Examining a Message Queue | Previous Page: EndDeferWindowPos

Notebook exported on Monday, 7 July 2008, 18:56:50 PM Eastern Daylight Time