GetCursorPos

The GetCursorPos function retrieves the cursor's position, in screen coordinates.

BOOL GetCursorPos(
  LPPOINT lpPoint   // address of structure for cursor position
);
 

Parameters

lpPoint
Pointer to a POINT structure that receives the screen coordinates of the cursor.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The cursor position is always given in screen coordinates and is not affected by the mapping mode of the window that contains the cursor.

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

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in winuser.h.
  Import Library: Use user32.lib.

See Also

Cursors Overview, Cursor Functions, ClipCursor, POINT, SetCursor, SetCursorPos, ShowCursor