windows_programming_notes.nbk: Home | Index | Next Page: GetDlgItem | Previous Page: GetDateFormat

 GetDlgCtrlID

The GetDlgCtrlID function retrieves the identifier of the specified control.

Syntax

    int GetDlgCtrlID(
        HWND hwndCtl
    );

Parameters

• hwndCtl
  [in] Handle to the control.

Return Value

If the function succeeds, the return value is the identifier of the control.

If the function fails, the return value is zero. An invalid value for the hwndCtl parameter, for example, will cause the function to fail. To get extended error information, call GetLastError.

Remarks

GetDlgCtrlID accepts child window handles as well as handles of controls in dialog boxes. An application sets the identifier for a child window when it creates the window by assigning the identifier value to the hmenu parameter when calling the CreateWindow or CreateWindowEx function.

Although GetDlgCtrlID may return a value if hwndCtl is a handle to a top-level window, top-level windows cannot have identifiers and such a return value is never valid.

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: GetDlgItem | Previous Page: GetDateFormat

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