Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

ZipArchive::CreateEntry Method (String, CompressionLevel)

.NET Framework 4.5

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

Namespace:  System.IO.Compression
Assembly:  System.IO.Compression (in System.IO.Compression.dll)
public:
ZipArchiveEntry^ CreateEntry(
	String^ entryName, 
	CompressionLevel compressionLevel
)

Parameters

entryName
Type: System::String

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

compressionLevel
Type: System.IO.Compression::CompressionLevel

One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.

Return Value

Type: System.IO.Compression::ZipArchiveEntry
An empty entry in the zip archive.
ExceptionCondition
ArgumentException

entryName is Empty.

ArgumentNullException

entryName is nullptr.

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 name already exists in the archive, a second entry is created with the same name.

The value of the LastWriteTime property for the new entry is set to the current time. Set the compressionLevel parameter to Optimal if you want the file to be compressed as much as possible. Set the compressionLevel parameter to Fastest only if you are concerned that the compression operation will not complete quickly enough for your scenario.

The following example shows how to create an entry with the optimal compression level. It also writes to the new entry by using a stream.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.1, 4.5

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1

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.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.