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

Table of Contents	< < Previous	Next >>

 

Chapter Fourteen — Project Functions (continued)

ProjectGetEntryData Function

Overview

The ProjectGetEntryData function will retrieve all the saved properties associated with a file entry by index from the currently open project.

Syntax/Parameters

Syntax

string[] = ProjectGetEntryData ( int index );

Parameters

index

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

Return Value

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

Remarks

See the introduction of this section for the key names. The key names match those used by the ProjectInsertEntry and the ProjectSetEntryData functions. Transient values are not returned.

	Key Name		Description
	Filename		Entry filename. Generally relative but can be set as an absolute path.
	Type		General string (EDGAR Document Type)
	Description		General string (EDGAR Document Description)
	Comment		General string
	EditStatus		General string
	Switches		General string
	Member		Member set as string tokens: ‘Web’, ‘Book’, ‘Help’, ‘EDGAR’, ‘Support’, ‘UserA’ and ‘UserB’. For EDGAR products, ‘EDGAR’ is always assumed if blank.

 

Related Functions

ProjectGetEntry — Gets the filename associated with an 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.