ReadOptions Class

DotNetZip

previous page next page

Ionic Zip Library v1.9.1.6 ReadOptions Class

A class for collecting the various options that can be used when Reading zip files for extraction or update.

Declaration Syntax

Visual Basic

Visual C++

public class ReadOptions

Public Class ReadOptions

public ref class ReadOptions

Members

All Members	Constructors	Methods	Properties
Public Protected		Instance Static		Declared Inherited

Icon	Member	Description
	ReadOptions()()()()	Initializes a new instance of the ReadOptions class
	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.
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize()()()()	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode()()()()	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType()()()()	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone()()()()	Creates a shallow copy of the current Object. (Inherited from Object.)
	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.
	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.
	ToString()()()()	Returns a String that represents the current Object. (Inherited from Object.)

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.

. .

Inheritance Hierarchy

Object
	ReadOptions