Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter SixFile Functions (continued)

GetCaretYPosition Function

Overview

The GetCaretYPosition function returns the Y position of the caret as either a native or a realized position.

Syntax/Parameters

Syntax

int = GetCaretYPosition ( handle hObject );

Parameters

hObject

A handle to an Edit Object or an Edit View.

Return Value

Returns an int containing the zero-based position of the caret or -1 on failure. Use the GetLastError function to retrieve error information.

Remarks

Not all windows and edit objects support caret positions. If the hEditObject parameter contains an invalid handle, the GetLastError function will return ERROR_INVALID_HANDLE.

Related Functions

Platform Support

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

Legato IDE, Legato Basic