onBeginFile (event)

Fired before each file is processed.

Syntax

- (void)onBeginFile:(int)index :(int*)skip;
func onBeginFile(_ index: Int32, _ skip: inout Int32)

Remarks

BeginFile is fired before each file is processed by the compressor or decompressor, as appropriate. Index contains the array index of the file about to be processed, and the FileCompressedName, FileDecompressedName, FileCompressedSize (decompression only), and FileDecompressedSize fields of the Files collection for this index contain more detailed information about the file about to be processed.

When extracting, an alternate location may be specified by trapping the event, and modifying FileDecompressedName and/or ExtractToPath. If the appropriate value of FileDecompressedName is set to an empty string, the file will not be written to disk. If WriteToProgressEvent is true, the file will still be decompressed, and the data may be extracted through the Progress event.

This event may also be trapped while compressing. FileCompressedName and FileDecompressedName may be changed.

You may set the Skip parameter to true in order to skip the file completely while compressing or extracting.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks ZIP 2020 iOS Edition - Version 20.0 [Build 8300]