DialogBoxIndirect

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 is defined as a macro and creates a modal dialog box from a dialog box template in memory. The DialogBoxIndirectmacro does not return control until the specified callback function terminates the modal dialog box by calling the EndDialogfunction.

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 DialogBoxIndirectuses 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 DLGTEMPLATEstructure followed by additional variable-length arrays. The data for each control consists of a DLGITEMTEMPLATEstructure followed by additional variable-length arrays.

In an extended template for a dialog box, the header uses the DLGTEMPLATEEXformat and the control definitions use the DLGITEMTEMPLATEEXformat.

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 Values

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

Remarks

The DialogBoxIndirectmacro uses the CreateWindowExfunction to create the dialog box. DialogBoxIndirectthen sends a WM_INITDIALOGmessage 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, DialogBoxIndirectdestroys 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.

In a standard dialog box template, the DLGTEMPLATEstructure and each of the DLGITEMTEMPLATEstructures must be aligned on DWORDboundaries. The creation data array that follows a DLGITEMTEMPLATEstructure must also be aligned on a DWORDboundary. All of the other variable-length arrays in the template must be aligned on WORDboundaries.

In an extended dialog box template, the DLGTEMPLATEEXheader and each of the DLGITEMTEMPLATEEXcontrol definitions must be aligned on DWORDboundaries. The creation data array, if any, that follows a DLGITEMTEMPLATEEXstructure must also be aligned on a DWORDboundary. All of the other variable-length arrays in the template must be aligned on WORDboundaries.

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

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

Requirements

Runs on	Versions	Defined in	Include	Link to
Windows CE OS	1.0 and later	Winuser.h

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.