GetDlgItem function

Retrieves a handle to a control in the specified dialog box.

Syntax

HWND GetDlgItem(
  HWND hDlg,
  int  nIDDlgItem
);

Parameters

hDlg

Type: HWND

A handle to the dialog box that contains the control.

nIDDlgItem

Type: int

The identifier of the control to be retrieved.

Return Value

Type: HWND

If the function succeeds, the return value is the window handle of the specified control.

If the function fails, the return value is NULL, indicating an invalid dialog box handle or a nonexistent control. To get extended error information, call GetLastError.

Remarks

You can use the GetDlgItem function with any parent-child window pair, not just with dialog boxes. As long as the hDlg parameter specifies a parent window and the child window has a unique identifier (as specified by the hMenu parameter in the CreateWindow or CreateWindowEx function that created the child window), GetDlgItem returns a valid handle to the child window.

Examples

For an example, see Initializing a Dialog Box.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header winuser.h (include Windows.h)
Library User32.lib
DLL User32.dll

See Also

Conceptual

CreateWindow

CreateWindowEx

Dialog Boxes

GetDlgItemInt

GetDlgItemText

Reference