ClipCursor

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

This function confines the cursor to a rectangular area on the screen. If a subsequent cursor position (set by the SetCursorPosfunction or the mouse) lies outside the rectangle, Windows CE automatically adjusts the cursor position to keep it inside the rectangular area.

BOOL ClipCursor(
CONST RECT *
lpRect
);

Parameters

lpRect

[in] Long pointer to the RECTstructure that contains the screen coordinates of the upper-left and lower-right corners of the confining rectangle. If this parameter is NULL, the cursor is free to move anywhere on the screen.

Return Values

Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

The cursor is a shared resource. If an application confines the cursor, it must release the cursor by using ClipCursorbefore relinquishing control to another application.

The calling process must have WINSTA_WRITEATTRIBUTES access to the window station.

Requirements

Runs on	Versions	Defined in	Include	Link to
Windows CE OS	1.0 and later	Winuser.h		Cursor.lib, Mcursor.lib

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.