GetClipCursor

This function retrieves the screen coordinates of the rectangular area to which the cursor is confined.

At a Glance

Header file:	Winuser.h
Windows CE versions:	1.0 and later

Syntax

BOOL GetClipCursor( LPRECT lpRect );

Parameters

lpRect

[out] Long 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 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 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.