Represents a package of compressed files in the zip archive format.
Assembly: System.IO.Compression (in System.IO.Compression.dll)
Thetype exposes the following members.
|ZipArchive(Stream)||Initializes a new instance of the class from the specified stream.|
|ZipArchive(Stream, ZipArchiveMode)||Initializes a new instance of the class from the specified stream and with the specified mode.|
|ZipArchive(Stream, ZipArchiveMode, Boolean)||Initializes a new instance of the class on the specified stream for the specified mode, and optionally leaves the stream open.|
|ZipArchive(Stream, ZipArchiveMode, Boolean, Encoding)||Initializes a new instance of the class on the specified stream for the specified mode, uses the specified encoding for entry names, and optionally leaves the stream open.|
|CreateEntry(String)||Creates an empty entry that has the specified path and entry name in the zip archive.|
|CreateEntry(String, CompressionLevel)||Creates an empty entry that has the specified entry name and compression level in the zip archive.|
|Dispose||Releases the resources used by the current instance of the class.|
|Dispose(Boolean)||Called by the Dispose and Finalize methods to release the unmanaged resources used by the current instance of the class, and optionally finishes writing the archive and releases the managed resources.|
|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.)|
|GetEntry||Retrieves a wrapper for the specified entry in the zip archive.|
|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.)|
|ToString||Returns a string that represents the current object. (Inherited from Object.)|
|CreateEntryFromFile(String, String)||Overloaded. Archives a file by compressing it and adding it to the zip archive. (Defined by ZipFileExtensions.)|
|CreateEntryFromFile(String, String, CompressionLevel)||Overloaded. Archives a file by compressing it using the specified compression level and adding it to the zip archive. (Defined by ZipFileExtensions.)|
|ExtractToDirectory||Extracts all the files in the zip archive to a directory on the file system. (Defined by ZipFileExtensions.)|
The class enables you to work with a package of compressed files. The package contains an entry for each compressed file. You can:
Retrieve an entry by using the GetEntry method.
Retrieve the entire collection of entries by using the Entries property.
Create a new entry in the package by calling the overloaded CreateEntry method.
For static methods to create a zip archive from a directory or extract a zip archive to a directory, see the ZipFile class.
When you create a new entry, the file is compressed and added to the zip package. The CreateEntry method enables you to specify a directory hierarchy when adding the entry. You include the relative path of the new entry within the zip package. For example, creating a new entry with a relative path of AddedFolder\NewFile.txt creates a compressed text file in a directory named AddedFolder.
If you reference the System.IO.Compression.FileSystem assembly in your project, you can access three extension methods (from the ZipFileExtensions class) for the class: CreateEntryFromFile, CreateEntryFromFile, and ExtractToDirectory. These extension methods enable you to compress and decompress the contents of the entry to a file. The System.IO.Compression.FileSystem assembly is not available for Windows Store apps. In Windows Store apps, you can compress and decompress files by using the DeflateStream or GZipStream class, or you can use the Windows Runtime types Compressor and Decompressor.
The first example shows how to create a new entry and write to it by using a stream.
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 following example shows how to open a zip archive and iterate through the collection of entries.
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
The third example shows how to use extension methods to create a new entry in a zip archive from an existing file and extract the archive contents. You must reference the System.IO.Compression.FileSystem assembly to execute the code.
Imports System.IO Imports System.IO.Compression Module Module1 Sub Main() Dim zipPath As String = "c:\users\exampleuser\end.zip" Dim extractPath As String = "c:\users\exampleuser\extract" Dim newFile As String = "c:\users\exampleuser\NewFile.txt" Using archive As ZipArchive = ZipFile.Open(zipPath, ZipArchiveMode.Update) archive.CreateEntryFromFile(newFile, "NewEntry.txt", CompressionLevel.Fastest) archive.ExtractToDirectory(extractPath) End Using End Sub End Module
Windows Phone 8.1, Windows Phone 8, 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.