C# Class Crisis.Ionic.Zip.ZipEntry

Extract the entry to the filesystem, starting at the current working directory.

This method extracts an entry from a zip file into the current working directory. The path of the entry as extracted is the full path as specified in the zip archive, relative to the current working directory. After the file is extracted successfully, the file attributes and timestamps are set.

The action taken when extraction an entry would overwrite an existing file is determined by the property.

Within the call to Extract(), the content for the entry is written into a filesystem file, and then the last modified time of the file is set according to the LastModified property on the entry. See the remarks the LastModified property for some details about the last modified time.

Extract the entry to a file in the filesystem, using the specified behavior when extraction would overwrite an existing file.

See the remarks on the LastModified property, for some details about how the last modified time of the file is set after extraction.

Extracts the entry to the specified stream.

The caller can specify any write-able stream, for example a , a , or ASP.NET's Response.OutputStream. The content will be decrypted and decompressed as necessary. If the entry is encrypted and no password is provided, this method will throw.

The position on the stream is not reset by this method before it extracts. You may want to call stream.Seek() before calling ZipEntry.Extract().

Extract the entry to the filesystem, starting at the specified base directory.

Using this method, existing entries in the filesystem will not be overwritten. If you would like to force the overwrite of existing files, see the ExtractExistingFile property, or call Extract(string, ExtractExistingFileAction).

See the remarks on the LastModified property, for some details about how the last modified time of the created file is set.

Extract the entry to the filesystem, starting at the specified base directory, and using the specified behavior when extraction would overwrite an existing file.

See the remarks on the LastModified property, for some details about how the last modified time of the created file is set.

Extract the entry to a file in the filesystem, relative to the current directory, using the specified behavior when extraction would overwrite an existing file.

See the remarks on the LastModified property, for some details about how the last modified time of the created file is set.

Extracts the entry to the specified stream, using the specified Password. For example, the caller could extract to Console.Out, or to a MemoryStream.

The caller can specify any write-able stream, for example a , a , or ASP.NET's Response.OutputStream. The content will be decrypted and decompressed as necessary. If the entry is encrypted and no password is provided, this method will throw.

The position on the stream is not reset by this method before it extracts. You may want to call stream.Seek() before calling ZipEntry.Extract().

Extract the entry to the filesystem, using the current working directory and the specified password.

Existing entries in the filesystem will not be overwritten. If you would like to force the overwrite of existing files, see the property, or call .

See the remarks on the LastModified property for some details about how the "last modified" time of the created file is set.

Extract the entry to the filesystem, starting at the specified base directory, and using the specified behavior when extraction would overwrite an existing file.

See the remarks on the LastModified property, for some details about how the last modified time of the created file is set.

Extract the entry to the filesystem, starting at the specified base directory, and using the specified password.

Existing entries in the filesystem will not be overwritten. If you would like to force the overwrite of existing files, see the property, or call .

See the remarks on the LastModified property, for some details about how the last modified time of the created file is set.

Opens a readable stream corresponding to the zip entry in the archive. The stream decompresses and decrypts as necessary, as it is read.

DotNetZip offers a variety of ways to extract entries from a zip file. This method allows an application to extract an entry by reading a System.IO.Stream.

The return value is of type . Use it as you would any stream for reading. When an application calls on that stream, it will receive data from the zip entry that is decrypted and decompressed as necessary.

CrcCalculatorStream adds one additional feature: it keeps a CRC32 checksum on the bytes of the stream as it is read. The CRC value is available in the property on the CrcCalculatorStream. When the read is complete, your application should check this CRC against the ZipEntry.Crc property on the ZipEntry to validate the content of the ZipEntry. You don't have to validate the entry using the CRC, but you should, to verify integrity. Check the example for how to do this.

If the entry is protected with a password, then you need to provide a password prior to calling OpenReader(), either by setting the Password property on the entry, or the ZipFile.Password property on the ZipFile itself. Or, you can use OpenReader(String), the overload of OpenReader that accepts a password parameter.

If you want to extract entry data into a write-able stream that is already opened, like a System.IO.FileStream, do not use this method. Instead, use Extract(Stream).

Your application may use only one stream created by OpenReader() at a time, and you should not call other Extract methods before completing your reads on a stream obtained from OpenReader(). This is because there is really only one source stream for the compressed content. A call to OpenReader() seeks in the source stream, to the beginning of the compressed content. A subsequent call to OpenReader() on a different entry will seek to a different position in the source stream, as will a call to Extract() or one of its overloads. This will corrupt the state for the decompressing stream from the original call to OpenReader().

The OpenReader() method works only when the ZipEntry is obtained from an instance of ZipFile. This method will throw an exception if the ZipEntry is obtained from a .

Opens a readable stream for an encrypted zip entry in the archive. The stream decompresses and decrypts as necessary, as it is read.

See the documentation on the OpenReader() method for full details. This overload allows the application to specify a password for the ZipEntry to be read.

Sets the NTFS Creation, Access, and Modified times for the given entry.

When adding an entry from a file or directory, the Creation, Access, and Modified times for the given entry are automatically set from the filesystem values. When adding an entry from a stream or string, the values are implicitly set to DateTime.Now. The application may wish to set these values to some arbitrary value, before saving the archive, and can do so using the various setters. If you want to set all of the times, this method is more efficient.

The values you set here will be retrievable with the , CreationTime and properties.

When this method is called, if both and are false, then the EmitTimesInWindowsFormatWhenSaving flag is automatically set.

DateTime values provided here without a DateTimeKind are assumed to be Local Time.

Provides a string representation of the instance.

Default constructor.

Applications should never need to call this directly. It is exposed to support COM Automation environments.

Copy metadata that may have been changed by the app. We do this when resetting the zipFile instance. If the app calls Save() on a ZipFile, then tries to party on that file some more, we may need to Reset() it , which means re-reading the entries and then copying the metadata. I think.

Finds a particular segment in the given extra field. This is used when modifying a previously-generated extra field, in particular when removing the AES crypto segment in the extra field.

generate and return a byte array that encodes the filename for the entry.

side effects: generate and store into _CommentBytes the byte array for any comment attached to the entry. Also sets _actualEncoding to indicate the actual encoding used. The same encoding is used for both filename and comment.

Returns true if the passed-in value is a valid signature for a ZipDirEntry.

/// The text encoding actually used for this ZipEntry. ///

/// ///

/// This read-only property describes the encoding used by the /// ZipEntry. If the entry has been read in from an existing ZipFile, /// then it may take the value UTF-8, if the entry is coded to specify UTF-8. /// If the entry does not specify UTF-8, the typical case, then the encoding /// used is whatever the application specified in the call to /// ZipFile.Read(). If the application has used one of the overloads of /// ZipFile.Read() that does not accept an encoding parameter, then the /// encoding used is IBM437, which is the default encoding described in the /// ZIP specification.

/// If the entry is being created, then the value of ActualEncoding is taken /// according to the logic described in the documentation for .

/// An application might be interested in retrieving this property to see if /// an entry read in from a file has used Unicode (UTF-8).

Prepare the given stream for output - wrap it in a CountingStream, and then in a CRC stream, and an encryptor and deflator as appropriate.

Previously this was used in ZipEntry.Write(), but in an effort to introduce some efficiencies in that method I've refactored to put the code inline. This method still gets called by ZipOutputStream.

Stores the position of the entry source stream, or, if the position is already stored, seeks to that position.

This method is called in prep for reading the source stream. If PKZIP encryption is used, then we need to calc the CRC32 before doing the encryption, because the CRC is used in the 12th byte of the PKZIP encryption header. So, we need to be able to seek backward in the source when saving the ZipEntry. This method is called from the place that calculates the CRC, and also from the method that does the encryption of the file data.

The first time through, this method sets the _sourceStreamOriginalPosition field. Subsequent calls to this method seek to that position.

At current cursor position in the stream, read the extra field, and set the properties on the ZipEntry instance appropriately. This can be called when processing the Extra field in the Central Directory, or in the local header.

Reads one entry from the zip directory structure in the zip file.

Reads one ZipEntry from the given stream. The content for the entry does not get decompressed or decrypted. This method basically reads metadata, and seeks.

Set the input stream and get its length, if possible. The length is used for progress updates, AND, to allow an optimization in case of a stream/file of zero length. In that case we skip the Encrypt and compression Stream. (like DeflateStream or BZip2OutputStream)

Validates that the args are consistent.

Only one of {baseDir, outStream} can be non-null. If baseDir is non-null, then the outputFile is created.