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.
A version of this page is also available for
4/8/2010

This function creates a modal dialog box from a dialog box template resource. DialogBoxdoes not return control until the specified callback function terminates the modal dialog box by calling the EndDialogfunction.

Syntax 

int DialogBox( 
  HINSTANCE 
hInstance, 
  LPCTSTR 
lpTemplate, 
  HWND 
hWndParent, 
  DLGPROC 
lpDialogFunc
);

Parameters

hInstance

[in] Handle to the module whose executable file contains the dialog box template.

lpTemplate

[in] Long pointer to the dialog box template. This parameter is either the pointer to a null-terminated character string that specifies the name of the dialog box template or an integer value that specifies the resource identifier of the dialog box template. If the parameter specifies a resource identifier, its high-order word must be zero and its low-order word must contain the identifier. You can use the MAKEINTRESOURCEmacro to create this value.

hWndParent

[in] Handle to the window that owns the dialog box.

lpDialogFunc

[in] Long pointer to the dialog box procedure. For more information about the dialog box procedure, see DialogProc.

Return Value

The value of the nResultparameter in the call to the EndDialogfunction indicates success. –1 indicates failure. To get extended error information, call GetLastError.

Remarks

The DialogBoxmacro uses the CreateWindowExfunction to create the dialog box. DialogBoxthen sends a WM_INITDIALOG message to the dialog box procedure. The function displays the dialog box (regardless of whether the template specifies the WS_VISIBLE style), disables the owner window, and starts its own message loop to retrieve and dispatch messages for the dialog box.

When the dialog box procedure calls the EndDialogfunction, DialogBoxdestroys the dialog box, ends the message loop, enables the owner window (if previously enabled), and returns the value of the nResultparameter specified by the dialog box procedure when it called EndDialog.

Windows Embedded CE does not support all styles in the DLGTEMPLATEstructure. This structure is in the template identified by the lpTemplateparameter .

Requirements

Header winuser.h
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also