Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FourteenProject 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

Platform Support

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