GetClipCursor function (winuser.h)
Retrieves the screen coordinates of the rectangular area to which the cursor is confined.
Syntax
BOOL GetClipCursor(
[out] LPRECT lpRect
);
Parameters
[out] lpRect
Type: LPRECT
A pointer to a RECT structure that receives the screen coordinates of the confining rectangle. The structure receives the dimensions of the screen if the cursor is not confined to a rectangle.
Return value
Type: BOOL
If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.
Remarks
The cursor is a shared resource. If an application confines the cursor with the ClipCursor function, it must later release the cursor by using ClipCursor before relinquishing control to another application.
The calling process must have WINSTA_READATTRIBUTES access to the window station.
Examples
For an example, see Confining a Cursor.
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 |
See also
Conceptual
Other Resources
Reference