ZipArchive.CreateEntry Method (String)

.NET Framework (current version)
 

Creates an empty entry that has the specified path and entry name in the zip archive.

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

Public Function CreateEntry (
	entryName As String
) As ZipArchiveEntry

Parameters

entryName
Type: System.String

A path, relative to the root of the archive, that specifies the name of the entry to be created.

Return Value

Type: System.IO.Compression.ZipArchiveEntry

An empty entry in the zip archive.

Exception Condition
ArgumentException

entryName is Empty.

ArgumentNullException

entryName is null.

NotSupportedException

The zip archive does not support writing.

ObjectDisposedException

The zip archive has been disposed.

The entryName string should reflect the relative path of the entry you want to create within the zip archive. There is no restriction on the string you provide. However, if it is not formatted as a relative path, the entry is created, but you may get an exception when you extract the contents of the zip archive. If an entry with the specified path and name already exists in the archive, a second entry is created with the same path and name.

The value of the LastWriteTime property for the new entry is set to the current time. The entry is compressed using the default compression level of the underlying compression algorithm. If you want to specify a different compression level, use the CreateEntry method.

The following example shows how to create an 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

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
Return to top
Show: