CreateDialogParam function

Creates a modeless dialog box from a dialog box template resource. Before displaying the dialog box, the function passes an application-defined value to the dialog box procedure as the lParam parameter of the WM_INITDIALOG message. An application can use this value to initialize dialog box controls.

Syntax


HWND WINAPI CreateDialogParam(
  _In_opt_  HINSTANCE hInstance,
  _In_      LPCTSTR lpTemplateName,
  _In_opt_  HWND hWndParent,
  _In_opt_  DLGPROC lpDialogFunc,
  _In_      LPARAM dwInitParam
);

Parameters

hInstance [in, optional]

Type: HINSTANCE

A handle to the module which contains the dialog box template. If this parameter is NULL, then the current executable is used.

lpTemplateName [in]

Type: LPCTSTR

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 low-order word must contain the identifier. You can use the MAKEINTRESOURCE macro to create this value.

hWndParent [in, optional]

Type: HWND

A handle to the window that owns the dialog box.

lpDialogFunc [in, optional]

Type: DLGPROC

A pointer to the dialog box procedure. For more information about the dialog box procedure, see DialogProc.

dwInitParam [in]

Type: LPARAM

The value to be passed to the dialog box procedure in the lParam parameter in the WM_INITDIALOG message.

Return value

Type: HWND

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

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

Remarks

The CreateDialogParam function uses the CreateWindowEx function to create the dialog box. CreateDialogParam 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, CreateDialogParam returns the window handle of the dialog box.

After CreateDialogParam returns, the application displays the dialog box (if it is not already displayed) 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.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winuser.h (include Windows.h)

Library

User32.lib

DLL

User32.dll

Unicode and ANSI names

CreateDialogParamW (Unicode) and CreateDialogParamA (ANSI)

See also

Reference
CreateDialog
CreateDialogIndirect
CreateDialogIndirectParam
CreateWindowEx
DestroyWindow
DialogProc
IsDialogMessage
MAKEINTRESOURCE
ShowWindow
WM_INITDIALOG
WM_SETFONT
Conceptual
Dialog Boxes

 

 

Community Additions

ADD
Show:
© 2014 Microsoft