Compress Method

Creates the compressed gzip archive.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int Compress();

Unicode (Windows)
INT Compress();

- (void)compress;

#define MID_GZIP_COMPRESS 4

IPWORKSZIP_EXTERNAL int IPWORKSZIP_CALL IPWorksZip_Gzip_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

Invoking Compress creates the archive specified by ArchiveFile. When the method is called, the file specified by FileDecompressedName will be opened, and the file specified by ArchiveFile will contain the compressed output.

The filename to be stored within the archive is given by FileCompressedName. If this property is set to the empty string, it will be set to an appropriate value automatically; the class always writes a filename in the gzip headers.

As the data is compressed the Progress event will be fired at regular intervals. This event may be used to stream out the gzip file, or to display a progress bar to the user.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)