Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter SixFile Functions (continued)

GetLineSize Function

Overview

The GetLineSize function will return the size in bytes of a line of text from a Mapped Text or Edit Object.

Syntax/Parameters

Syntax

int = GetLineSize ( handle hObject, int index, [boolean realized] );

Parameters

hObject

A handle to a valid Mapped Text or Edit Object.

index

An int containing a zero-based index to the line of data within the Mapped Text Object.

realized

An optional boolean flag, when set to TRUE forces the function to return the size as a realized value. The default is FALSE.

Return Value

Returns an int containing the number of characters for the specified line or -1 on failure. Use the GetLastError function to retrieve error information.

Remarks

The GetLineSize function returns the “native” or “realized” size of the line, that is, with or without tab expansion.

This function is only applicable to text type edit objects.

If the hObject parameter is invalid, the GetLastError function will return ERROR_FILE | ERROR_INVALID_HANDLE.

Related Functions

Platform Support

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

Legato IDE, Legato Basic