ZipArchive.GetEntry(String) Method

Definition

Retrieves a wrapper for the specified entry in the zip archive.

public System.IO.Compression.ZipArchiveEntry GetEntry (string entryName);
Parameters
entryName
String

A path, relative to the root of the archive, that identifies the entry to retrieve.

Returns

A wrapper for the specified entry in the archive; null if the entry does not exist in the archive.

Exceptions

entryName is Empty.

entryName is null.

The zip archive does not support reading.

The zip archive has been disposed.

The zip archive is corrupt, and its entries cannot be retrieved.

Examples

The following example shows how to use the GetEntry method to retrieve an entry.

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

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

            using (ZipArchive archive = ZipFile.Open(zipPath, ZipArchiveMode.Update))
            {
                ZipArchiveEntry entry = archive.GetEntry("ExistingFile.txt");
                using (StreamWriter writer = new StreamWriter(entry.Open()))
                {
                    writer.BaseStream.Seek(0, SeekOrigin.End);
                    writer.WriteLine("append line to file");
                }
                entry.LastWriteTime = DateTimeOffset.UtcNow.LocalDateTime;
            }
        }
    }
}
Imports System.IO
Imports System.IO.Compression

Module Module1

    Sub Main()
        Dim zipPath As String = "c:\example\result.zip"

        Using archive As ZipArchive = ZipFile.Open(zipPath, ZipArchiveMode.Update)
            Dim entry As ZipArchiveEntry = archive.GetEntry("ExistingFile.txt")

            Using writer As StreamWriter = New StreamWriter(entry.Open())
                writer.BaseStream.Seek(0, SeekOrigin.End)
                writer.WriteLine("append line to file")
            End Using
            entry.LastWriteTime = DateTimeOffset.UtcNow.LocalDateTime
        End Using
    End Sub

End Module

Remarks

If multiple entries that have the specified name exist in the archive, the first one is returned. The name of the entry is compared to entryName using ordinal comparison.

Applies to