DialogBoxIndirect

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function is defined as a macro and creates a modal dialog box from a dialog box template in memory. The DialogBoxIndirect macro does not return control until the specified callback function terminates the modal dialog box by calling the EndDialog function.

Syntax

int DialogBoxIndirect( 
  HINSTANCE hInstance, 
  LPDLGTEMPLATE lpTemplate, 
  HWND hWndParent, 
  DLGPROC lpDialogFunc
);

Parameters

  • hInstance
    [in] Handle to the module that creates the dialog box.

  • lpTemplate
    [in] Long pointer to a global memory object containing a template that DialogBoxIndirect uses to create the dialog box. A dialog box template consists of a header that describes the dialog box, followed by one or more additional blocks of data that describe each of the controls in the dialog box. The template can use either the standard format or the extended format.

    In a standard template for a dialog box, the header is a DLGTEMPLATE structure followed by additional variable-length arrays. The data for each control consists of a DLGITEMTEMPLATE structure followed by additional variable-length arrays.

  • 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 nResult parameter specified in the call to the EndDialog function indicates success. –1 indicates failure. To get extended error information, call GetLastError.

Remarks

The DialogBoxIndirect macro uses the CreateWindowEx function to create the dialog box. DialogBoxIndirect then 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 EndDialog function, DialogBoxIndirect destroys the dialog box, ends the message loop, enables the owner window (if previously enabled), and returns the value of the nResult parameter specified by the dialog box procedure when it called EndDialog.

In a standard dialog box template, the DLGTEMPLATE structure and each of the DLGITEMTEMPLATE structures must be aligned on DWORD boundaries. The creation data array that follows a DLGITEMTEMPLATE structure must also be aligned on a DWORD boundary. All of the other variable-length arrays in the template must be aligned on WORD boundaries.

All character strings in the dialog box template, such as titles for the dialog box and buttons, must be Unicode strings.

Windows Embedded CE does not support all styles in the DLGTEMPLATE structure. This structure is in the template identified by the lpTemplate parameter*.*

Requirements

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

See Also

Reference

CreateWindowEx
DialogBox
DialogBoxIndirectParam
DialogBoxParam
DialogProc
EndDialog
WM_INITDIALOG
DLGITEMTEMPLATE
DLGTEMPLATE
Dialog Boxes Functions