  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Fourteen — Project Functions (continued)
Overview
The ProjectSetInfo function sets data in the Project Information Table either as information accessed by predefined meta keywords or as user environment names.
Syntax/Parameters
Syntax
int = ProjectSetInfo ( string name, [string data] );
Parameters
name
A string that defines the name of the project meta information. Certain names are predefined.
data
An optional string specifying the data to be associated with the name. If omitted, the meta data is deleted from the project. (This differs from an empty string which will leave the named field with empty data.) Predefine keywords cannot be deleted.
Return Value
Returns an int containing ERROR_NONE (0) or a formatted error code. Use the GetLastError function to retrieve error information.
Remarks
The SetProjectInfo 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. This field is read-only.
“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).
A total of 2048 bytes of data is allowed to be stored as predefined meta keyword slots (not including the project filename).
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.