Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral Functions (continued)

GetScriptMapLine Function

Overview

The GetScriptMapLine function returns the current line within the complete program map being executed.

Syntax/Parameters

Syntax

int = GetScriptMapLine ( );

Parameters

(none)

Return Value

Returns an int with the zero-based position of the current line being executed within the overall map of the script.

Remarks

The map position is the program position in the overall execution map for the script after all files have been assembled and condition definitions processed. The map position can be the same as the line position, if the current file does not include any additional scripts or there are not any multiple statement lines.

Multi-statement lines will count as multiple map lines. For example:

a = 1; b = 3; c = 5;

counts as three lines in the map.

This can be useful for retrieving the current execution position for logs and other functionalities.

Related Functions

Platform Support

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

Legato IDE, Legato Basic