学步园

DialogBox 宏从体格对话框模板资源创建一个模态对话框，DialogBox 不返回控制直到指定的回调函数调用 EndDialog 函数终止了模态对话框，DialogBox 宏使用 DialogBoxParam 函数。

Syntax

INT_PTR DialogBox(
  __in  HINSTANCE hInstance,
  __in  LPCTSTR lpTemplate,
  __in  HWND hWndParent,
  __in  DLGPROC lpDialogFunc
);

INT_PTR DialogBox(
  __in  HINSTANCE hInstance,
  __in  LPCTSTR lpTemplate,
  __in  HWND hWndParent,
  __in  DLGPROC lpDialogFunc
);

Parameters

hInstance [in]

HINSTANCE

Handle to the module whose executable file contains the dialog box template.

lpTemplate [in]

LPCTSTR

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]

HWND

Handle to the window that owns the dialog box.

lpDialogFunc [in]

DLGPROC

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

Return Value

INT_PTR

If the function succeeds, the return value is the nResult parameter in the call to the EndDialog function used to terminate the dialog box.

If the function fails because the hWndParent parameter is invalid, the return value is zero. The function returns zero in this case for compatibility with previous versions of Windows. If the function fails for any other reason, the return value is –1. 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 DialogBox macro uses the CreateWindowEx function to create the dialog box. DialogBox 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 (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, DialogBox destroys the dialog box, ends the message loop, enables the owner window (if previously enabled), and returns the nResult parameter specified by the dialog box procedure when it called EndDialog.

Examples

For an example, see Creating a Modal Dialog Box.