Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FifteenWindows/OS Functions (continued)

GetCursorPosition Function

Overview

The GetCursorPosition function returns the current position of the mouse.

Syntax/Parameters

Syntax

int [] = GetCursorPosition ( [handle hWindow] );

Parameters

hWindow

An optional window handle when specified the returned x and y position are relative to the client area of the specified window.

Return Value

An int array pair containing the X and Y positions or an empty array on error. Use the GetLastError function to return a formatted error code. The code will contain a Windows error code with an API error type.

The array key name values are “x” and “y” for the 0 and 1 index positions, respectively.

Remarks

The cursor position is always specified in screen or client 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 and the input desktop must be the current desktop. See MSDN for further details.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic