GetDlgCtrlID function (winuser.h)
Retrieves the identifier of the specified control.
Syntax
int GetDlgCtrlID(
[in] HWND hWnd
);
Parameters
[in] hWnd
Type: HWND
A handle to the control.
Return value
Type: int
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.
Examples
For an example, see Initializing a Dialog Box.
Requirements
| Requirement | Value |
|---|---|
| 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 |
| API set | ext-ms-win-ntuser-dialogbox-l1-1-0 (introduced in Windows 8) |
See also
Conceptual
Reference