IPWorks ZIP 2020 JavaScript Edition

Questions / Feedback?

BeginFile Event

Fired before each file is processed.

Syntax

sevenzip.on('BeginFile', listener: (e: {readonly index: number, skip: boolean}) => void )

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 FilesCompressedName, FilesDecompressedName, FilesCompressedSize (decompression only), and FilesDecompressedSize 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 FilesDecompressedName and/or ExtractToPath. If the appropriate value of FilesDecompressedName 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. FilesCompressedName and FilesDecompressedName may be changed.

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

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks ZIP 2020 JavaScript Edition - Version 20.0 [Build 7720]