ZipEntry Class

DotNetZip

Ionic Zip Library v1.9.1.6 ZipEntry Class
ReferenceIonic.ZipZipEntry
Represents a single entry in a ZipFile. Typically, applications get a ZipEntry by enumerating the entries within a ZipFile, or by adding an entry to a ZipFile.
Declaration Syntax
C# Visual Basic Visual C++
public class ZipEntry
Public Class ZipEntry
public ref class ZipEntry
Members
All Members Constructors Methods Properties



Icon Member Description
ZipEntry()()()()
Default constructor.

AccessedTime
Last Access time for the file represented by the entry.

AlternateEncoding
Specifies the alternate text encoding used by this ZipEntry

AlternateEncodingUsage
Describes if and when this instance should apply AlternateEncoding to encode the FileName and Comment, when saving.

Attributes
The file attributes for the entry.

BitField
The bitfield for the entry as defined in the zip spec. You probably never need to look at this.

Comment
The comment attached to the ZipEntry.

CompressedSize
The compressed size of the file, in bytes, within the zip archive.

CompressionLevel
Sets the compression level to be used for the entry when saving the zip archive. This applies only for CompressionMethod = DEFLATE.

CompressionMethod
The compression method employed for this ZipEntry.

CompressionRatio
The ratio of compressed size to uncompressed size of the ZipEntry.

Crc
The 32-bit CRC (Cyclic Redundancy Check) on the contents of the ZipEntry.

CreationTime
The file creation time for the file represented by the entry.

EmitTimesInUnixFormatWhenSaving
Specifies whether the Creation, Access, and Modified times for the given entry will be emitted in "Unix(tm) format" when the zip archive is saved.

EmitTimesInWindowsFormatWhenSaving
Specifies whether the Creation, Access, and Modified times for the given entry will be emitted in "Windows format" when the zip archive is saved.

Encryption
Set this to specify which encryption algorithm to use for the entry when saving it to a zip archive.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Extract()()()()
Extract the entry to the filesystem, starting at the current working directory.

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

Extract(Stream)
Extracts the entry to the specified stream.

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

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

ExtractExistingFile
The action the library should take when extracting a file that already exists.

ExtractWithPassword(String)
Extract the entry to the filesystem, using the current working directory and the specified password.

ExtractWithPassword(String, String)
Extract the entry to the filesystem, starting at the specified base directory, and using the specified password.

ExtractWithPassword(ExtractExistingFileAction, String)
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.

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

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

FileName
The name of the file contained in the ZipEntry.

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.)
IncludedInMostRecentSave
Indicates whether the entry was included in the most recent save.

Info
Provides a human-readable string with information about the ZipEntry.

InputStream
The stream that provides content for the ZipEntry.

InputStreamWasJitProvided
A flag indicating whether the InputStream was provided Just-in-time.

IsDirectory
True if the entry is a directory (not a file). This is a readonly property on the entry.

IsText
Indicates whether an entry is marked as a text file. Be careful when using on this property. Unless you have a good reason, you should probably ignore this property.

LastModified
The time and date at which the file indicated by the ZipEntry was last modified.

MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
ModifiedTime
Last Modified time for the file represented by the entry.

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

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

OutputUsedZip64
Indicates whether the entry actually used ZIP64 extensions, as it was most recently written to the output file or stream.

Password
The Password to be used when encrypting a ZipEntry upon ZipFile.Save(), or when decrypting an entry upon Extract().

ProvisionalAlternateEncoding Obsolete.
The text encoding to use for the FileName and Comment on this ZipEntry, when the default encoding is insufficient.

RequiresZip64
Indicates whether the entry requires ZIP64 extensions.

SetCompression
A callback that allows the application to specify the compression to use for a given entry that is about to be added to the zip archive.

SetEntryTimes(DateTime, DateTime, DateTime)
Sets the NTFS Creation, Access, and Modified times for the given entry.

Source
An enum indicating the source of the ZipEntry.

Timestamp
The type of timestamp attached to the ZipEntry.

ToString()()()()
Provides a string representation of the instance.
(Overrides Object.ToString()()()().)
UncompressedSize
The size of the file, in bytes, before compression, or after extraction.

UsesEncryption
A derived property that is true if the entry uses encryption.

UseUnicodeAsNecessary Obsolete.
Set to indicate whether to use UTF-8 encoding for filenames and comments.

VersionNeeded
The version of the zip engine needed to read the ZipEntry.

ZipErrorAction
The action to take when an error is encountered while opening or reading files as they are saved into a zip archive.

Inheritance Hierarchy
Object
ZipEntry

Assembly: Ionic.Zip (Module: Ionic.Zip) Version: 1.9.1.8 (1.9.1.8)