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.
A version of this page is also available for
4/8/2010

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

Syntax 

BOOL GetClipCursor( 
  LPRECT 
lpRect
);

Parameters

lpRect

[out] Long pointer to a RECTstructure 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

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 ClipCursorfunction, it must later release the cursor by using ClipCursorbefore relinquishing control to another application.

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

Requirements

Header winuser.h
Library Cursor.lib, Mcursor.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also