GetDlgItem

This function retrieves the handle to a control in the specified dialog box.

At a Glance

Header file:	Winuser.h
Windows CE versions:	1.0 and later

Syntax

HWND GetDlgItem( HWND hDlg, int nIDDlgItem );

Parameters

hDlg

[in] Handle to the dialog box that contains the control.

nIDDlgItem

[in] Specifies the identifier of the control to be retrieved.

Return Values

The window handle of the specified control indicates success. NULL indicates failure due to 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.

The GetDlgItem function works for immediate child controls of a dialog box—it does not search through nested dialog boxes.