ClipCursor

  • Article

This function confines the cursor to a rectangular area on the screen. If a subsequent cursor position (set by the SetCursorPos function 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 RECT structure 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 this function before relinquishing control to another application.

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

Requirements

OS Versions: Windows CE 1.0 and later.
Header: Winuser.h.
Link Library: Cursor.lib, Mcursor.lib.

See Also

GetClipCursor | GetCursorPos | SetCursorPos | RECT

 Last updated on Wednesday, April 14, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.