Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter FiveGeneral Functions (continued)

NativeToRealized Function

Overview

The NativeToRealized function translates a tabbed position to a realized position.

Syntax/Parameters

Syntax

int = NativeToRealized ( string reference, int position, [int tab_stops] );

int = NativeToRealized ( handle hMappedText, int line, int position );

Parameters

reference

A source string containing the data to use as a reference for translation. The source cannot exceed 1,048,575 characters in size. When reference is used, hMappedText and line cannot be used.

hMappedText

A handle to a Mapped Text or Edit Object to use to source the reference string. When used, reference cannot be supplied and line must be supplied.

line

An int specifying a valid zero-based line position for the reference string within the Mapped Text Object. This parameter is only used with a Mapped Text Object.

position

An int specifying the zero-based character position to translate.

tab_stops

An optional int specifying the size/stop position of tab characters. By default this value is 8 characters. This parameter may only be used with the reference parameter.

Return Value

Returns an int as the translated position or a formatted error code on failure.

Remarks

The NativeToRealized function scans the string and creates a native position based on the number of characters/tabs and their fill characters. When used with a Mapped Text Object, the expansion is performed automatically. To use a string, the ExpandTabs function must be called on the string prior to performing the translation.

Related Functions

Platform Support

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

Legato IDE, Legato Basic