GetClipCursor

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 retrieves the screen coordinates of the rectangular area to which the cursor is confined.

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 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 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

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.