Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Download Visual Studio Add-In

GetCursor (user32)
 
.
Summary
Retrieves the cursor position in screen coordinates.
Summary

C# Signature:

[DllImport("user32.dll", SetLastError = true)]
[return: MarshalAs(UnmanagedType.Bool)]
static extern bool GetCursorPos(out POINT lpPoint);
// DON'T use System.Drawing.Point, the order of the fields in System.Drawing.Point isn't guaranteed to stay the same.

[DllImport("user32.dll")]
static extern IntPtr GetCursor();

VB.NET Signature:

<DllImport("user32.dll", ExactSpelling := True, SetLastError := True)> _
    Public Shared Function GetCursorPos(ByRef lpPoint As POINT) As <MarshalAs(UnmanagedType.Bool)> Boolean
    End Function
Private Declare Function GetCursor Lib "user32.dll" () As IntPtr

User-Defined Types:

None.

VB Signature:

Declare Function GetCursorPos Lib "user32.dll" _
   (ByRef lpPoint As POINT) as boolean

<DllImport("user32.dll")> _
   Public Function GetCursorPos(<[In](), Out()> ByRef pt As POINT) As Boolean
   End Function

Point declaration

<System.Runtime.InteropServices.StructLayout(Runtime.InteropServices.LayoutKind.Sequential)> _
   Public Structure POINT
      Public X As Integer
      Public Y As Integer

      Public Sub New(ByVal X As Integer, ByVal Y As Integer)
     Me.X = X
     Me.Y = Y
      End Sub
   End Structure

User-Defined Types:

POINT

Notes:

None.

Tips & Tricks:

Please add some!

Tested on Unity Engine. Sould be works on other .Net Framework/IDE:

Sample Code:

Please add some!

// *************************************************************************************
using System.Collections.Generic;
using UnityEngine;
using System.Runtime.InteropServices;

public class GetCursorPosTest : MonoBehaviour
{
    private ulong lpPoint = 0;
    [DllImport("user32.dll")] static extern bool GetCursorPos(out ulong _lpPoint);

Alternative Managed API:

Do you know one? Please contribute it!

    void LateUpdate()
    {    
        GetCursorPos(out lpPoint);
        int _x   =   (int)( lpPoint & 0x00000000FFFFFFFF);
        ulong _y = (ulong)( lpPoint & 0xFFFFFFFF00000000) >> 32;
        Debug.Log(_x + " / " + _y );
    }
}
// *************************************************************************************

Documentation
GetCursor on MSDN

Sample Code:

POINT p;
if (GetCursorPos(out p))
{
    label1.Text = Convert.ToString(p.X) + ";" + Convert.ToString(p.Y);
}

Alternative Managed API:

System.Windows.Forms.Cursor.Position

Documentation

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Edit This Page
Find References
Show Printable Version
Revisions