  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Fourteen — Project Functions (continued)
Overview
The ProjectSetEntryData function replaces the existing data associated with an entry in the project file entry list with new data.
Syntax/Parameters
Syntax
int = ProjectSetEntryData ( int index, string[] array | [string type, string
description,
string
comment, string status, string switches,
string
member] );
Parameters
index
An int that specifies the zero-based position of the entry to replace.
array
A string array specifying the data elements of the items. The key names are: Type, Description, Comment, EditStatus, Switches and Member. Other key names such as Filename will be ignored. See parameters below for size limits. If the size is exceeded the value is truncated without warning. If the array is employed, then no other parameters are allowed.
type
An optional string containing a descriptive type. For EDGAR this is the same as the ‘document type’. Maximum of 256 characters. If array is specified, this parameter should not be used.
description
An optional string containing a description. For EDGAR this is the same as the ‘document description’. Maximum of 512 characters. If array is specified, this parameter should not be used.
comment
An optional string containing a comment. For EDGAR this can be the same as the segment or module CIK. Maximum of 1024 characters. If array is specified, this parameter should not be used.
status
An optional string containing a status string. For EDGAR this is the same as the segment CCC. Maximum of 256 characters. If array is specified, this parameter should not be used.
switches
An optional string containing switches. Maximum of 256 characters. If array is specified, this parameter should not be used.
member
An optional string containing publishing member keywords. Maximum of 128 characters. If array is specified, this parameter should not be used.
Return Value
Returns an int as ERROR_NONE or a formatted error code on failure.
Remarks
For array mode, the key names are as follows:
| 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. |
Size limits are not indicative of any EDGAR limits which are significantly smaller. See the EDGAR Filer Manual for details. Exceeding the above parameter sizes will result in a runtime error. Fields are not validated.
Project caret and select positions are not adjusted. However, the project window (Management View) is automatically updated.
See Project Entry Functions for additional information on key names.
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.