  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The CompressFile function uses the common zlib compression library to compress a file.
Syntax/Parameters
Syntax
int = CompressFile ( string source, string destination, [int level] );
Parameters
source
A string specifying a qualified source filename to compress. For maximum flexibility, this file is opened with read access and share write/read.
destination
A string specifying a qualified destination filename to compress. If a file of the same name already exists, it is overwritten.
level
An optional int specifying the type or level of compression. If omitted, the default compression is used.
Return Value
Returns an int as ERROR_NONE or a formatted error code on failure. The ERROR_DT_SOURCE (0x00100000) and ERROR_DT_DESTINATION (0x00200000) bits may be set to identify an error with a specific file operation.
Remarks
The level codes are as follows:
| Define | Bitwise Value | Description | ||||
| ZLIB_NO_COMPRESSION | 0 | No compression | ||||
| ZLIB_BEST_SPEED | 1 | Best speed | ||||
| ZLIB_BEST_COMPRESSION | 9 | Best compression | ||||
| ZLIB_DEFAULT_COMPRESSION | 6 | Default compression |
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.