ZipArchiveEntry Class

.NET Framework (current version)

Note
The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Represents a compressed file within a zip archive.

Namespace: Â System.IO.Compression
Assembly: Â System.IO.Compression (in System.IO.Compression.dll)

Inheritance Hierarchy

System.Object
â€‚â€‚System.IO.Compression.ZipArchiveEntry

Syntax

C++

public class ZipArchiveEntry

Properties

	Name	Description
	Archive	Gets the zip archive that the entry belongs to.
	CompressedLength	Gets the compressed size of the entry in the zip archive.
	ExternalAttributes	OS and application specific file attributes.
	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.

Methods

	Name	Description
	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().)

A zip archive contains an entry for each compressed file. The ZipArchiveEntry 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.

The methods for manipulating zip archives and their file entries are spread across three classes: ZipFile, ZipArchive and ZipArchiveEntry.

Toâ€¦	Useâ€¦
Create a zip archive from a directory	ZipFile.CreateFromDirectory
Extract the contents of a zip archive to a directory	ZipFile.ExtractToDirectory
Add new files to an existing zip archive	ZipArchive.CreateEntry
Retrieve an file in a zip archive	ZipArchive.GetEntry
Retrieve all of the files in a zip archive	ZipArchive.Entries
To open a stream to an individual file contained in a zip archive	ZipArchiveEntry.Open
Delete a file from a zip archive	ZipArchiveEntry.Delete

If you reference the System.IO.Compression.FileSystem assembly in your project, you can access two extension methods for the ZipArchiveEntry 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 8.x 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.

Examples

The first example shows how to create a new entry in a zip archive and write to it.

using System;
using System.IO;
using System.IO.Compression;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            using (FileStream zipToOpen = new FileStream(@"c:\users\exampleuser\release.zip", FileMode.Open))
            {
                using (ZipArchive archive = new ZipArchive(zipToOpen, ZipArchiveMode.Update))
                {
                    ZipArchiveEntry readmeEntry = archive.CreateEntry("Readme.txt");
                    using (StreamWriter writer = new StreamWriter(readmeEntry.Open()))
                    {
                            writer.WriteLine("Information about this package.");
                            writer.WriteLine("========================");
                    }
                }
            }
        }
    }
}

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.

using System;
using System.IO;
using System.IO.Compression;

namespace ConsoleApplication1
{
    class Program
    {
        static void Main(string[] args)
        {
            string zipPath = @"c:\example\start.zip";
            string extractPath = @"c:\example\extract";

            using (ZipArchive archive = ZipFile.OpenRead(zipPath))
            {
                foreach (ZipArchiveEntry entry in archive.Entries)
                {
                    if (entry.FullName.EndsWith(".txt", StringComparison.OrdinalIgnoreCase))
                    {
                        entry.ExtractToFile(Path.Combine(extractPath, entry.FullName));
                    }
                }
            } 
        }
    }
}

Version Information

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.5
Portable Class Library
Supported in: portable .NET platforms
Windows Phone
Available since 8.1

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.