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 creates a modal dialog box from a dialog box template in memory. Before displaying the dialog box, the function passes an application-defined value to the dialog box procedure as the lParamparameter of the WM_INITDIALOG message. An application can use this value to initialize dialog box controls.
int DialogBoxIndirectParam( HINSTANCE hInstance , LPCDLGTEMPLATE hDialogTemplate , HWND hWndParent , DLGPROC lpDialogFunc , LPARAM dwInitParam );
Parameters
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.
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 DialogBoxIndirectParamfunction uses the CreateWindowExfunction to create the dialog box. DialogBoxIndirectParamthen 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, DialogBoxIndirectParamdestroys 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.
If the user presses ALT+H while the dialog box has the input focus, the system posts a WM_HELP message to the dialog procedure. An application should respond to this message by displaying context-sensitive Help for the dialog box.
For other dialog restrictions, see CreateDialogIndirectParam.
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.
See Also
CreateDialogIndirectParam, CreateWindowEx, DialogBox, DialogBoxIndirect, DialogBoxParam, DialogProc, EndDialog, WM_INITDIALOG, DLGITEMTEMPLATE, DLGITEMTEMPLATEEX, DLGTEMPLATE, DLGTEMPLATEEX