Extract Method
Extracts the compressed file from the bzip2 archive.
Syntax
ANSI (Cross Platform) int Extract(); Unicode (Windows) INT Extract();
- (void)extract;
#define MID_BZIP2_EXTRACT 6 IPWORKSZIP_EXTERNAL int IPWORKSZIP_CALL IPWorksZip_Bzip2_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);
Remarks
Invoking Extract decompresses the archive specified by ArchiveFile. The compressed file will be extracted, and written to disk.
If FileDecompressedName is set to a nonempty string the file will be written there. Otherwise the class will automatically set FileDecompressedName to an appropriate value:
If ArchiveFile ends in ".bz2", this filename, less the ".bz2" extension will be used.
If this condition does not hold, ".unzipped" will be appended to ArchiveFile.
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.)