Represents a compressed file within a zip archive.
Assembly: System.IO.Compression (in System.IO.Compression.dll)
Thetype exposes the following members.
|Archive||Gets the zip archive that the entry belongs to.|
|CompressedLength||Gets the compressed size of the entry in the zip archive.|
|FullName||Gets the relative path of the entry in the zip archive.|
|LastWriteTime||Gets or sets the last time the entry in the zip archive was changed.|
|Length||Gets the uncompressed size of the entry in the zip archive.|
|Name||Gets the file name of the entry in the zip archive.|
|Delete||Deletes the entry from the zip archive.|
|Equals(Object)||Determines whether the specified object is equal to the current object. (Inherited from Object.)|
|Finalize||Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)|
|GetHashCode||Serves as the default hash function. (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.)|
|Open||Opens the entry from the zip archive.|
|ToString||Retrieves the relative path of the entry in the zip archive. (Overrides Object.ToString.)|
|ExtractToFile(String)||Overloaded. Extracts an entry in the zip archive to a file. (Defined by ZipFileExtensions.)|
|ExtractToFile(String, Boolean)||Overloaded. Extracts an entry in the zip archive to a file, and optionally overwrites an existing file that has the same name. (Defined by ZipFileExtensions.)|
A zip archive contains an entry for each compressed file. The class enables you to examine the properties of an entry, and open or delete the entry. When you open an entry, you can modify the compressed file by writing to the stream for that compressed file. You open an entry by calling the Open method.
If you reference the System.IO.Compression.FileSystem assembly in your project, you can access two extension methods for the class. Those methods are ExtractToFile(ZipArchiveEntry, String) and ExtractToFile(ZipArchiveEntry, String, Boolean), and they enable you to decompress the contents of the entry to a file. The System.IO.Compression.FileSystem assembly is not available in Windows 8. In Windows Store apps, you can decompress the contents of an archive by using DeflateStream or GZipStream, or you can use the Windows Runtime types Compressor and Decompressor to compress and decompress files.
You can retrieve an entry either by iterating through the Entries collection in ZipArchive, or by calling the GetEntry method in ZipArchive. You can create a new entry by calling CreateEntry or CreateEntryFromFile.
The first example shows how to create a new entry in a zip archive and write to it.
Imports System.IO Imports System.IO.Compression Module Module1 Sub Main() Using zipToOpen As FileStream = New FileStream("c:\users\exampleuser\release.zip", FileMode.Open) Using archive As ZipArchive = New ZipArchive(zipToOpen, ZipArchiveMode.Update) Dim readmeEntry As ZipArchiveEntry = archive.CreateEntry("Readme.txt") Using writer As StreamWriter = New StreamWriter(readmeEntry.Open()) writer.WriteLine("Information about this package.") writer.WriteLine("========================") End Using End Using End Using End Sub End Module
The second example shows how to use the ExtractToFile(ZipArchiveEntry, String) extension method. You must reference the System.IO.Compression.FileSystem assembly in your project for the code to execute.
Imports System.IO Imports System.IO.Compression Module Module1 Sub Main() Dim zipPath As String = "c:\example\start.zip" Dim extractPath As String = "c:\example\extract" Using archive As ZipArchive = ZipFile.OpenRead(zipPath) For Each entry As ZipArchiveEntry In archive.Entries If entry.FullName.EndsWith(".txt", StringComparison.OrdinalIgnoreCase) Then entry.ExtractToFile(Path.Combine(extractPath, entry.FullName)) End If Next End Using End Sub End Module
Windows Phone 8.1, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.