Function Reference

Table of Contents

I. Constants
II. Userlib Functions
ZlibWapi_Adler32 - Generates an Adler-32 checksum for the contents of a Blitz bank.
ZlibWapi_Compress2 - Compress the bank sourceBank with a level specified by compressionLevel.
ZlibWapi_CompressBound - Estimates the size of buffer required to compress sourceLength bytes of data.
ZlibWapi_Compress - Compresses a Blitz bank.
ZlibWapi_Crc32 - Computes a running CRC-32 checksum.
ZlibWapi_UnCompress - Decompresses the data in a Blitz bank.
ZlibWapi_UnzCloseCurrentFile - Closes the file that was opened with "ZlibWapi_UnzOpenCurrentFile".
ZlibWapi_UnzClose - Closes a zip file opened with ZlibWapi_UnzOpen.
ZlibWapi_UnzGetCurrentFileInfo - Gets information about the file pointed at by the current file pointer.
ZlibWapi_UnzGetGlobalComment - Gets the global comment for a ZIP file opened with UnzOpen.
ZlibWapi_UnzGetGlobalInfo - Gets information about a ZIP file that was opened with UnzOpen.
ZlibWapi_UnzGoToFirstFile - Sets the current file pointer to the first file in the ZIP.
ZlibWapi_UnzGoToNextFile - Moves the current file pointer to the next file in the ZIP.
ZlibWapi_UnzLocateFile - Tries to locate the file "fileName" in the zipfile, and if successful sets the current file to the found file.
ZlibWapi_UnzOpenCurrentFile - Opens the file pointed at by the current file pointer for reading.
ZlibWapi_UnzOpen - Open a zip file for reading / writing.
ZlibWapi_UnzReadCurrentFile - Reads data from the currently open file and uncompresses it into memory.
ZlibWapi_zError - Gets a string indentifying an error with the code "errorCode".
ZlibWapi_ZipCloseFileInZip - Closes a file in a ZIP that was opened by "ZlibWapi_ZipOpenNewFileInZip".
ZlibWapi_ZipClose - Closes a file that has been opened with ZlibWapi_ZipOpen.
ZlibWapi_ZipOpenNewFileInZip - Create a new file entry in a ZIP file.
ZlibWapi_ZipOpenNewFileInZip3 - Extended function for creating a new file entry in a ZIP file.
ZlibWapi_ZipOpen - Opens a ZIP file for writing. If the file doesn't exist, it will be created.
ZlibWapi_ZipWriteFileInZip - Writes the contents of a bank to an opened ZIP file entry.
ZlibWapi_ZlibVersion - Returns the version of Zlib being used.
III. Wrapper Functions
ZipApi_AddBankAsFile - Add a file to a ZIP directly from bank data.
ZipApi_AddFile - Add a file to a ZIP that has been opened with ZipApi_CreateZip.
ZipApi_Adler32 - Calculates the Adler32 of a bank.
ZipApi_Close - Closes a zip file. Make sure to close files opened with ZipApi_OpenCurrentFile first.
ZipApi_CloseZip - Closes a ZIP resource that was opened with ZipApi_CreateZip.
ZipApi_Compress - Compresses a Blitz bank, and returns a new bank containing the compressed data.
ZipApi_CompressBank - Compress a bank, and return the result as a new bank with size information appended.
ZipApi_Crc32 - Calculates the CRC32 value a bank.
ZipApi_CreateZip - Create and open a new ZIP file for adding files to.
ZIPAPI_Date_Create - Create and return a new ZIPAPI_Date object, based on the current time and date.
ZIPAPI_Date_Dispose - Frees the memory used by a ZIPAPI_Date object and deletes it.
ZIPAPI_Date_FromBank - Creates a new ZipApi_Date object and reads its contents from a bank.
ZIPAPI_Date_FromFile - Create and return a new ZIPAPI_Date object, based on the information for a file.
ZIPAPI_Date_ToBank - Places the contents of a ZIPAPI_Date object into a bank.
ZipApi_ExtractFile - Extracts a file from a ZIP and returns the path to open it.
ZipApi_ExtractFileAsBank - Extracts a file from a zip and returns it as a Blitz bank.
ZipApi_GetCurrentFileInfoFast - Gets information about the current file in an opened ZIP.
ZipApi_GetCurrentFileInfo - Gets information about the current file pointed at in the zip.
ZipApi_GetFileInfo - Gets information about any file within a zip file.
ZipApi_GetGlobalInfo - Gets information about an open zip file, such as how many files it contains.
ZipApi_GetUnpackedSize - Gets the total uncompressed size of a Zip file.
ZIPAPI_GlobalInfo_Dispose - Free the memory used by a ZIPAPI_GlobalInfo object and delete it.
ZIPAPI_GlobalInfo_FromBank - Create a ZIPAPI_GlobalInfo object and read data from the contents of a bank.
ZipApi_GotoFirstFile - Sets the zip's internal file pointer to the first file in the zip.
ZipApi_GotoNextFile - Sets the current file of the zip to the next file.
ZipApi_Open - Open a zip file for reading.
ZipApi_UnCompress - Uncompresses the contents of a Blitz bank.
ZipApi_UnCompressBank - Uncompresses a bank previously compressed using ZipApi_CompressBank.
ZIPAPI_UnzFileInfo_Dispose - Free the memory used by a ZIPAPI_UnzFileInfo object.
ZIPAPI_UnzFileInfo_FromBank - Create a ZIPAPI_UnzFileInfo object and read data from the contents of a bank.
ZipApi_VerifyZipFileHeader - Checks that a file has the correct header.
ZipApi_ZipOpenFileInZip - A slightly simpler interface to ZlibWapi_ZipOpenNewFileInZip.