windows_programming_notes.nbk: Home | Index | Next Page: GetDlgItemInt | Previous Page: GetDlgCtrlID

 GetDlgItem

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

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 Value

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.

Example

For an example, see Initializing a 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

windows_programming_notes.nbk: Home | Index | Next Page: GetDlgItemInt | Previous Page: GetDlgCtrlID

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