Class ReadOptions
A class for collecting the various options that can be used when Reading zip files for extraction or update.
public class ReadOptions- Inheritance
-
ReadOptions
- Inherited Members
- Extension Methods
Remarks
When reading a zip file, there are several options an application can set, to modify how the file is read, or what the library does while reading. This class collects those options into one container.
Pass an instance of the ReadOptions class into the
ZipFile.Read() method.
Properties
Encoding
The System.Text.Encoding to use when reading in the zip archive. Be
careful specifying the encoding. If the value you use here is not the same
as the Encoding used when the zip archive was created (possibly by a
different archiver) you will get unexpected results and possibly exceptions.
public Encoding Encoding { get; set; }Property Value
- See Also
ReadProgress
An event handler for Read operations. When opening large zip
archives, you may want to display a progress bar or other
indicator of status progress while reading. This parameter
allows you to specify a ReadProgress Event Handler directly.
When you call Read(), the progress event is invoked as
necessary.
public EventHandler<ReadProgressEventArgs> ReadProgress { get; set; }Property Value
StatusMessageWriter
The System.IO.TextWriter to use for writing verbose status messages
during operations on the zip archive. A console application may wish to
pass System.Console.Out to get messages on the Console. A graphical
or headless application may wish to capture the messages in a different
TextWriter, such as a System.IO.StringWriter.
public TextWriter StatusMessageWriter { get; set; }