Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter NineDialog Functions (continued)

PageControlGetCaretY Function

Overview

The PageControlGetCaretY function returns the current caret Y position.

Syntax/Parameters

Syntax

int = PageControlGetCaretY ( int id );

Parameters

id

An int containing the control ID of the page control.

Return Value

An int as a zero-based file Y position or -1 on failure. Use the GetLastError function to retrieve a formatted error code. Common errors include: ERROR_RANGE if id is an invalid control ID for the open dialog or ERROR_INVALID_HANDLE if no dialog is open.

Remarks

The position within the control is always based on an X/Y file position.

Related Functions

Platform Support

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

Legato IDE, Legato Basic