SetCapture function (winuser.h)
Sets the mouse capture to the specified window belonging to the current thread. SetCapture captures mouse input either when the mouse is over the capturing window, or when the mouse button was pressed while the mouse was over the capturing window and the button is still down. Only one window at a time can capture the mouse.
If the mouse cursor is over a window created by another thread, the system will direct mouse input to the specified window only if a mouse button is down.
Syntax
HWND SetCapture(
[in] HWND hWnd
);
Parameters
[in] hWnd
Type: HWND
A handle to the window in the current thread that is to capture the mouse.
Return value
Type: HWND
The return value is a handle to the window that had previously captured the mouse. If there is no such window, the return value is NULL.
Remarks
Only the foreground window can capture the mouse. When a background window attempts to do so, the window receives messages only for mouse events that occur when the cursor hot spot is within the visible portion of the window. Also, even if the foreground window has captured the mouse, the user can still click another window, bringing it to the foreground.
When the window no longer requires all mouse input, the thread that created the window should call the ReleaseCapture function to release the mouse.
This function cannot be used to capture mouse input meant for another process.
When the mouse is captured, menu hotkeys and other keyboard accelerators do not work.
Examples
For an example, see Drawing Lines with the Mouse.
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-mouse-l1-1-0 (introduced in Windows 8) |
See also
Conceptual
Reference