  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Fourteen — Project Functions (continued)
Overview
The ProjectGetInfo function will retrieve project meta data for the currently open project from the Project Info Table for both predefined items and user-defined data.
Syntax/Parameters
Syntax
string = ProjectGetInfo ( string name );
Parameters
name
A string that defines the name of the project meta information. Certain names are predefined.
Return Value
Returns a string containing the project meta information or an empty string on failure. An empty string may indicate there was no information in the name position or that the name does not exist. Use the GetLastError function to retrieve error information.
Remarks
The GetProjectInfo function is the preferred method of accessing named meta data for a project. Project meta data is stored in the Project Info Table via name. See the section on Project File Specification for more information.
Project predefined names are as follows:
“Project-Filename” — Project’s filename.
“Project-Name” — Textual name of project (on Project Properties dialog).
“Project-Description” — Description of project (on Project Properties dialog).
“Project-Matter” — Control number for project (on Project Properties dialog).
“Project-Client-Name” — Client name (on Project Properties dialog).
“Project-Client-ID” — Client ID (on Project Properties dialog).
“Project-Agent-Name” — Agent Name (on Project Properties dialog).
“Project-Manager” — Manager’s name (on Project Properties dialog).
“Project-Revision” — Revision data (on Project Properties dialog).
“Project-Comments” — General Comments (on Project Properties dialog).
Conventionally, other meta names within the Project Info Table names begin with the prefix “ProjectInfo” if they are allowed to be accessed by the application environmental variable functions. If they do not have this prefix, then they can only be accessed from the project functions.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
| Table of Contents | < < Previous | Next >> |
© 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.