  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
This section covers functions that process complete files for copying, compressing and encoding.
Individual or multiple files can be compressed and decompressed using Legato.
The ‘zip’ functions for Legato version 1 will process creating or extracting files within a Zip Object. when a zip (or compressed) file is opened with ZipOpen, entries can be acted upon and extracted. When a Zip Object is created using the ZipCreate function, files may be added and written to a zip file. An existing zip file cannot be altered.
The Zip Object only supports store and deflate compression modes. These are the most common methods of compression.
Compression:
CompressFile — Compress file using ZLIB with optional compression level.
DecompressFile — Decompress file using ZLIB.
ZipCreate — Creates an empty Zip Object.
ZipAddFile — Adds a file for compression to the Zip Object with optional path/tree location.
ZipWrite — Writes Zip Object data to a specified file.
Copying:
CopyFile — Copy a file to another name or location.
Encoding:
DecodeFile — Decodes a file (base-64) from source to destination with optional mode.
EncodeFile — Encodes a file (base-64) from source to destination with optional mode and padding.
Zip Reading Support:
ZipOpen — Opens a zip file and returns a Zip Object handle.
ZipEnumerateEntries — Gets a list of entries (files, folders) contained within a compressed object.
ZipEnumerateFiles — Gets a list of files contained within a compressed object.
ZipEnumerateFolders — Gets a list of folders contained within a compressed object.
ZipExtractFile — Extracts a file by index or entry name to a Basic File or Pool Object or simple filename and path.
ZipExtractToFolder — Extracts all files (or as selected by wild card mask) to a specified folder.
ZipExtractToString — Decompresses or extracts file entry data into a string. Presumably the contents are text.
ZipFindEntry — Finds an entry and returns the zero-based index position within Zip Object.
ZipGetEntryProps — Returns all the known index properties for a specified file entry in the compressed object.
ZipGetEntryCompressionType — Returns the compression type for an item by zero-based index.
ZipGetEntryCount — Gets the total count of files in the Zip Object's file index.
ZipGetEntryName — Gets the entry name by index position and adjusted path as required.
ZipGetEntrySize — Gets the uncompressed size of a file entry.
ZipGetFolderCount — Returns the number of discrete folders in the object.
Zip Writing Support:
ZipCreate — Creates an empty Zip Object.
ZipAddFile — Adds a file for compression to the Zip Object with optional path/tree location.
ZipWrite — Writes Zip Object data to a specified file.
| 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.