Scan Method

Scans the compressed archive.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int Scan();

Unicode (Windows)
INT Scan();

- (void)scan;

#define MID_GZIP_SCAN 9

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

Remarks

This method will scan the gzip archive specified by ArchiveFile. The archive will be read, the header will be checked, and the stored filename will be written to FileCompressedName.

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 gzip file, or to determine an appropriate value for FileDecompressedName.

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.)