GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Fourteen — Project Functions (continued)

ProjectGetEntry Function

Overview

The ProjectGetEntry function will retrieve the name of a file entry by index from the currently open project.

Syntax/Parameters

Syntax

string = ProjectGetEntry ( int index, [boolean path] );

Parameters

index

An int that specifies the zero-based position of the entry within the project.

path

An optional boolean specifying whether or not the path should be included with the entry name. When TRUE, the function retrieves the path with the name. The default value is FALSE.

Return Value

Returns a string containing the file name of the project entry or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

The ProjectGetEntry function retrieves the name (and optionally the path) of the entry specified by the index parameter. The location specified by the index parameter may or may not contain a project entry 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

ProjectDeleteEntry — Deletes the specified entry.

ProjectGetEntryCount — Gets the count of primary entries.

ProjectGetEntryAsNumber — Gets a specified field associated with a project file entry as a numeric value.

ProjectGetEntryAsString — Gets a specified field associated with a project file entry as a string.

ProjectInsertEntry — Inserts an entry at position with optional parameters.

ProjectSetEntryData — Sets fields for an existing entry.

Platform Support

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

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.