  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Twenty-one — EDGARView Integration (continued)
EDGARArchiveGetDocFile Function
Overview
The EDGARArchiveGetDocFile function retrieves a specified file from the archive and saves a copy in a specified location.
Syntax/Parameters
Syntax
int = EDGARArchiveGetDocFile ( handle hArchive, int index, string destination );
Parameters
hArchive
A handle that specifies the EDGAR Archive opened with EDGARArchiveOpen function.
index
An integer specifying a file entry in the mapped object.
destination
A string containing a path or fully qualified filename. If the filename is omitted, the document filename is used in conjunction with the path as a destination file.
Return Value
An int specifying the result as ERROR_NONE (0) or a formatted error code. The error code can indicate a problem with the object handle, object content or the destination file.
Remarks
The EDGARArchiveGetDocFile extracts the file from the encoded archive. There is no warning or error on overwriting the destination file.
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.