  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Twenty-one — EDGARView Integration (continued)
EDGARArchiveGetDocDescription Function
Overview
The EDGARArchiveGetDocDescription function retrieves the document description as filed or created by the EDGAR system.
Syntax/Parameters
Syntax
string = EDGARArchiveGetDocDescription ( handle hArchive, int index );
Parameters
hArchive
A handle that specifies the EDGAR Archive opened with EDGARArchiveOpen function.
index
An integer specifying a file entry in the mapped object.
Return Value
A string containing the description. If an error occurs, the returned string will be empty. Use the GetLastError function to retrieve error details. Note that the document description is an optional field for filers and therefore can be empty without an error.
Remarks
Some descriptions are automatically generated by the EDGAR system (such as ‘IDEA’ descriptions for XBRL rendering content).
The EDGAR XML specification sets a limit of 255 characters for this field.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| 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.