  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The ZipExtractToString function extracts an entry from a Zip Object to a string.
Syntax/Parameters
Syntax
string = ZipExtractToString ( handle hZip, int index | string name );
Parameters
hZip
A handle for a Zip Object created with the ZipOpen function.
index
An int specifying the zero-based entry within the Zip Object. Or,
name
A string specifying an entry name. The direction of the slashes is not important.
Return Value
Returns a string containing the raw data from the entry or an empty string on failure. Use the GetLastError function to retrieve error information.
Remarks
This function is meant to extract text based file content. The ZipExtractToString function only supports store and deflate modes (codes 0 and 8). Any other modes will result in the function returning the error ERROR_FUNCTION_NOT_SUPPORTED.
The content should be compatible text without binary. Any zero bytes in the content will terminate the string data at that point. This function can seize the script thread for a long period of time if the file to be extracted is large.
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.