Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter FourteenProject Functions (continued)

ProjectGetInfoName Function

Overview

The ProjectGetInfoName function will retrieve the name of an entry by index from the Project Information Table of the currently open project.

Syntax/Parameters

Syntax

string = ProjectGetInfoName ( int index );

Parameters

index

An int that specifies a position in the Project Information Table.

Return Value

Returns a string containing the data corresponding to the position specified by index or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

When enumerating the Project Information Table by index, the Project Properties items will not be presented since they are not actually located in the internal named information table. In addition, the location specified by the index parameter may or may not contain data since the entry could have been deleted during the application session. An empty return string could indicate the position is empty or the index is out of range. Use the GetLastError function to determine if there was an error.

Note that script programmers should not rely on the position of information since it may change from project instance to instance.

Related Functions

Platform Support

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