Scan Method
Scans the compressed archive.
Syntax
ANSI (Cross Platform) int Scan(); Unicode (Windows) INT Scan();
- (void)scan;
#define MID_BZIP2_SCAN 9 IPWORKSZIP_EXTERNAL int IPWORKSZIP_CALL IPWorksZip_Bzip2_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);
Remarks
This method will scan the bzip archive specified by ArchiveFile. The archive will be read, and the header will be checked.
Unlike in the Zip, Tar, and Jar classs, it is never necessary to invoke this method, and it will not be automatically invoked by Extract. Suggested uses for this method would be to check that the file is a bzip file.
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.)