windows_programming_notes.nbk: Home | Index | Next Page: CreateDialogIndirect | Previous Page: Context menu on the fly

 CreateDialog

The CreateDialog macro creates a modeless dialog box from a dialog box template resource. The CreateDialog macro uses the CreateDialogParam function.

Syntax

    HWND CreateDialog(
        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] Specifies 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 MAKEINTRESOURCE macro to create this value.
• hWndParent
  [in] Handle to the window that owns the dialog box.
• lpDialogFunc
  [in] Pointer to the dialog box procedure. For more information about the dialog box procedure, see DialogProc.

Return Value

If the function succeeds, the return value is the handle to the dialog box.

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

This function typically fails for one of the following reasons:

• an invalid parameter value
• the system class was registered by a different module
• The WH_CBT hook is installed and returns a failure code
• if one of the controls in the dialog template is not registered, or its window window procedure fails WM_CREATE or WM_NCCREATE

Remarks

The CreateDialog function uses the CreateWindowEx function to create the dialog box. CreateDialog then sends a WM_INITDIALOG message (and a WM_SETFONT message if the template specifies the DS_SETFONT or DS_SHELLFONT style) to the dialog box procedure. The function displays the dialog box if the template specifies the WS_VISIBLE style. Finally, CreateDialog returns the window handle to the dialog box.

After CreateDialog returns, the application displays the dialog box (if it is not already displayed) by using the ShowWindow function. The application destroys the dialog box by using the DestroyWindow function. To support keyboard navigation and other dialog box functionality, the message loop for the dialog box must call the IsDialogMessage function.

Windows 95/98/Me:The system can support a maximum of 255 controls per dialog box template. To place more than 255 controls in a dialog box, create the controls in the WM_INITDIALOG message handler rather than placing them in the template.

Example

For an example, see Creating a Modeless 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 ANSI and Unicode versions.

windows_programming_notes.nbk: Home | Index | Next Page: CreateDialogIndirect | Previous Page: Context menu on the fly

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