ZipFile.ExtractToDirectory Method (String, String, Encoding)

.NET Framework 4.5

Extracts all the files in the specified zip archive to a directory on the file system and uses the specified character encoding for entry names.

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

public static void ExtractToDirectory(
	string sourceArchiveFileName,
	string destinationDirectoryName,
	Encoding entryNameEncoding
)

Parameters

sourceArchiveFileName
Type: System.String

The path to the archive that is to be extracted.

destinationDirectoryName
Type: System.String

The path to the directory in which to place the extracted files, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.

entryNameEncoding
Type: System.Text.Encoding

The encoding to use when reading or writing entry names in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names.

ExceptionCondition
ArgumentException

destinationDirectoryName or sourceArchiveFileName is Empty, contains only white space, or contains at least one invalid character.

-or-

entryNameEncoding is set to a Unicode encoding other than UTF-8.

ArgumentNullException

destinationDirectoryName or sourceArchiveFileName is null.

PathTooLongException

The specified path in destinationDirectoryName or sourceArchiveFileName exceeds the system-defined maximum length. For example, on Windows-based platforms, paths must not exceed 248 characters, and file names must not exceed 260 characters.

DirectoryNotFoundException

The specified path is invalid (for example, it is on an unmapped drive).

IOException

The directory specified by destinationDirectoryName already exists.

-or-

The name of an entry in the archive is Empty, contains only white space, or contains at least one invalid character.

-or-

Extracting an archive entry would create a file that is outside the directory specified by destinationDirectoryName. (For example, this might happen if the entry name contains parent directory accessors.)

-or-

An archive entry to extract has the same name as an entry that has already been extracted from the same archive.

UnauthorizedAccessException

The caller does not have the required permission to access the archive or the destination directory.

NotSupportedException

destinationDirectoryName or sourceArchiveFileName contains an invalid format.

FileNotFoundException

sourceArchiveFileName was not found.

InvalidDataException

The archive specified by sourceArchiveFileName is not a valid zip archive.

-or-

An archive entry was not found or was corrupt.

-or-

An archive entry was compressed by using a compression method that is not supported.

This method creates the specified directory and all subdirectories. The destination directory cannot already exist. Exceptions related to validating the paths in the destinationDirectoryName or sourceArchiveFileName parameters are thrown before extraction. Otherwise, if an error occurs during extraction, the archive remains partially extracted. Each extracted file has the same relative path to the directory specified by destinationDirectoryName as its source entry has to the root of the archive.

If entryNameEncoding is set to a value other than null, entry names are decoded according to the following rules:

  • For entry names where the language encoding flag (in the general-purpose bit flag of the local file header) is not set, the entry names are decoded by using the specified encoding.

  • For entries where the language encoding flag is set, the entry names are decoded by using UTF-8.

If entryNameEncoding is set to null, entry names are decoded according to the following rules:

  • For entries where the language encoding flag (in the general-purpose bit flag of the local file header) is not set, entry names are decoded by using the current system default code page.

  • For entries where the language encoding flag is set, the entry names are decoded by using UTF-8.

.NET Framework

Supported in: 4.5

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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft