bcl Wiki Rss Feed

Updated Wiki: Home

terrajobst — Tue, 16 Apr 2013 06:08:06 GMT

Project Description

The Base Class Libraries site hosts samples, previews, and prototypes from the BCL team.
This is a site for the BCL Team to get features to customers to try out without requiring a Beta or CTP of the .NET Framework. Our goal is to put generally useful functionality here, and to get feedback on it and have the chance to iterate on the design. Having a feature here does not mean that it will eventually end up in the BCL. Some items are samples that build on top of existing classes, and some features might be ones we were considering for the .NET Framework but decide not to include for one reason or another.

We'd love to get your feedback in the form of comments, bug reports, and feature requests, but please note that we cannot take code submissions. We plan to release updates with new features and updates to existing features on a quarterly basis, but we're just getting started with this and may adjust down the line depending on how things go.

And just to avoid confusion, you will not find the source code for the whole BCL on this CodePlex site. This site is for things we're thinking about for the future, not our existing classes.

Feature Descriptions

Below are descriptions of features currently in this project. You can find more details about each in the Documentation section of this project.

BigRational

BigRational builds on the BigInteger introduced in .NET Framework 4 to create an arbitrary-precision rational number class.

Long Path

This library provides functionality to make it easier to work with paths that are longer than the current 259 character limit.

PerfMonitor

PerfMonitor is a command-line tool for profiling the system using Event Tracing for Windows (ETW). PerfMonitor is built on top of the TraceEvent library.

TraceEvent

An library that greatly simplifies reading Event Tracing for Windows (ETW) events.

Related Sites

BCL Page on MSDN

BCL Team Blog

CLR Team Blog

Updated Wiki: Home

terrajobst — Thu, 21 Mar 2013 18:36:55 GMT

Project Description

Feature Descriptions

Below are descriptions of features currently in this project. You can find more details about each in the Documentation section of this project.

BigRational

BigRational builds on the BigInteger introduced in .NET Framework 4 to create an arbitrary-precision rational number class.

Long Path

This library provides functionality to make it easier to work with paths that are longer than the current 259 character limit.

PerfMonitor

PerfMonitor is a command-line tool for profiling the system using Event Tracing for Windows (ETW). PerfMonitor is built on top of the TraceEvent library.

TraceEvent

An library that greatly simplifies reading Event Tracing for Windows (ETW) events.

Related Sites

BCL Page on MSDN

BCL Team Blog

CLR Team Blog

Updated Wiki: PerfMonitor

VanceMorrison — Mon, 07 Jan 2013 04:10:22 GMT

PerfMonitor

PerfMonitor PerfMonitor is a command-line tool for profiling the system using Event Tracing for Windows (ETW) events. ETW is the power behind the Windows Performance Analyzer (also known as the XPerf Tool). The Windows OS has events for just about anything that you could be interested in from a performance standpoint (CPU usage, Context switched Disk I/O DLL Loads, Blocking, all with stack traces). In addition the .NET Runtime has events for garbage collection, Just In time Compilation, Assembly loading and more. PerfMonitor is a gateway to all of this information.

While PerfMonitor is a useful tool, it was really designed more as sample code for the TraceEvent library. This library is the 'heart' of PerfMonitor, and PerfMonitor is mostly a command line parser and XML printer layered on top of that. Nevertheless PerfMonitor has powerful features. It has the abilty to turn on and off any ETW provider, and thus can act as a 'light weight' controler even if you decide to use tools like XPERF to actually analyze the data. PerfMonitor also has better CLR support than XPERF currently has. PerfMonitor can decode the full managed and unmanaged stacks that ETW kernel events provide, as well as do CLR specific analysis (like GC pause time and JIT compilation statstics).

PerfMonitor has a 'analyze' command that is designed to be a 'Quick Perf Health Check' for managed applications. In one command you can run a program and get an anaysis of its CPU costs, as well as GC memory, and Just In Time compilation overhead.

PerfMonitor has a 'monitor' command that is designed to make it easy to use the new System.Diagnositics.Eventing.EventSource class. Running 'PerfMonitor monitorPrint EXEFILE' will turn on the event sources present in EXEFILE, run the EXEFILE, and then print the resulting loggint messages.

Please see the Perfmonitor Guide some 'quick starts' on what you can do with the tool, if you are interested follow the download link below.

Finally PerfMonitor was design to be 'easy to deploy'. It is just a single EXE, which can be fetched from the Download Page. It is XCOPY deployable (just copy the EXE out of the ZIP file). and you are ready to run it. Despite what the 'System Requirements window says (which is the max for all code on this site) PerfMonitor (and TraceEvent) only need V3.5 of the .NET Framework to be installed. If you are running Windows Vista or above or have Windows Update running you should have this. If PerfMonitor fails to load simply go to the link above and download it.

PerfMonitor does need at least windows VISTA. It will not work on XP or win2K3.

Having problems?

Ask a question
File a bug

Updated Wiki: PerfMonitor

VanceMorrison — Mon, 07 Jan 2013 04:08:29 GMT

PerfMonitor

Having problems?

Ask a question
File a bug

Updated Wiki: TraceEvent

VanceMorrison — Mon, 07 Jan 2013 04:07:08 GMT

TraceEvent

TraceEvent is an library that greatly simplifies reading Event Tracing for Windows (ETW) events. ETW is the power behind the Windows Performance Analyzer (also known as the XPerf Tool). The Windows OS has events for just about anything that you could be interested in from a performance standpoint (CPU usage, Context switched Disk I/O DLL Loads, Blocking, all with stack traces). In addition the .NET Runtime has events for garbage collection, Just In time Compilation, Assembly loading and more. TraceEvent was built for people who understand the power of the data that XPERF lets you get at, but also needs the capability to programatically maniputate that data. It is the foundation of truly powerful and flexible performance analysis on windows.

Getting started

First, see TraceEvent Class Overview to see if the functionality this download provides piques your interest.

If it does, the best way to understand how TraceEvent can be used in 'real life' scenarios is by exploring a sample. That is exactly what PerfMonitor is. It is a simple console-based application that can collect ETW data as ETL files and display them in various ways as XML. It is recommended that you simply download that application and learn see how it uses TraceEvent APIs to learn how to use it. PerfMonitor includes the TraceEvent library as part of its download, so you get both a sample and the library in one download. If you wish to just download TraceEvent without PerfMonitor you can do so by visiting the page.

Having problems?

New Comment on "Long Path Samples"

TomGroszko — Thu, 19 Jan 2012 23:50:32 GMT

Both of these need a way to create one from a DirectoryInfo and FileInfo class.

New Comment on "Long Path"

chedebalakrishna — Tue, 03 Jan 2012 23:38:05 GMT

Does the library has support to modify the permissions (setting/removing ACLs) on directories/files when the paths are longer.

New Comment on "Long Path"

ExtinctPencil2 — Fri, 25 Nov 2011 12:45:18 GMT

Thanks really Useful. Needs support for UNC paths ie where longPathPrefix = \\?\UNC\

New Comment on "TraceEvent Class Overview"

szilvaa — Wed, 30 Mar 2011 18:28:40 GMT

Will you be posting traceParserGen.exe any time? I have a bunch of custom events declared in a manifest and it would be nice to generate some skeleton code. Thanks!

Updated Wiki: PerfMonitor

VanceMorrison — Thu, 03 Mar 2011 19:33:11 GMT

PerfMonitor

Having problems?

Ask a question
File a bug

New Comment on "Perfmonitor Guide"

KevinBurton — Thu, 02 Dec 2010 02:36:04 GMT

If you do 'perfMonitor start' and the events are collected in perMonitorOutput.etl, how do I get the human readable output? I don't see that runPrint is an option for 'perfMonitor start'. Thank you for a great tool.

Updated Wiki: PerfMonitor

VanceMorrison — Thu, 19 Aug 2010 23:54:27 GMT

PerfMonitor

PerfMonitor PerfMonitor is a command-line tool for profiling the system using Event Tracing for Windows (ETW) events. ETW is the power behind the Windows Performance Analyzer (also known as the XPerf Tool). The Windows OS has events for just about anything that you could be interested in from a performance standpoint (CPU usage, Context switched Disk I/O DLL Loads, Blocking, all with stack traces). In addition the .NET Runtime has events for garbage collection, Just In time Compilation, Assembly loading and more. PerfMonitor is a gateway to all of this information.

While PerfMonitor is a useful tool, it was really designed more as sample code for the TraceEvent library. This library is the 'heart' of PerfMonitor, and PerfMonitor is mostly a command line parser and XML printer layered on top of that. Nevertheless PerfMonitor has powerful features. It has the abilty to turn on and off any ETW provider, and thus can act as a 'light weight' controler even if you decide to use tools like XPERF to actually analyze the data. PerfMonitor also has better CLR support than XPERF currently has. PerfMonitor can decode the full managed and unmanaged stacks that ETW kernel events provide, as well as do CLR specific analysis (like GC pause time and JIT compilation statstics).

PerfMonitor has a 'analyze' command that is designed to be a 'Quick Perf Health Check' for managed applications. In one command you can run a program and get an anaysis of its CPU costs, as well as GC memory, and Just In Time compilation overhead.

Please see the Perfmonitor Guide some 'quick starts' on what you can do with the tool, if you are interested follow the download link below.

Finally PerfMonitor was design to be 'easy to deploy'. It is just a single EXE, which can be fetched from the Download Page. It is XCOPY deployable (just copy the EXE out of the ZIP file). and you are ready to run it. Despite what the 'System Requirements window says (which is the max for all code on this site) PerfMonitor (and TraceEvent) only need V3.5 of the .NET Framework to be installed. If you are running Windows Vista or above or have Windows Update running you should have this. If PerfMonitor fails to load simply go to the link above and download it.

PerfMonitor does need at least windows VISTA. It will not work on XP or win2K3.

Having problems?

Ask a question
File a bug

Updated Wiki: ZipArchive

hrlee — Mon, 09 Aug 2010 18:47:10 GMT

ZipArchive

The ZipArchive class (along with its partner, ZipArchiveEntry) provide support for reading and writing Zip archives. For some discussion about these APIs, see the following BCL blog posts.

Discussion on BCL Blog
Follow-up to Discussion on BCL Blog

Getting started

TODO: Replace [#] in links below with actual files
Cannot resolve release macro, invalid id.
Cannot resolve release macro, invalid id.
Samples
Class Reference

Having problems?

Ask a question
File a bug

Updated Wiki: ZipArchive

hrlee — Fri, 06 Aug 2010 22:50:29 GMT

ZipArchive

Getting started

Cannot resolve release macro, invalid id.
Samples
Class Reference

Having problems?

Ask a question
File a bug

Updated Wiki: ZipArchive Class Reference

hrlee — Fri, 06 Aug 2010 22:50:00 GMT

ZipArchive Class

namespace Microsoft.Experimental.IO.Compression
{
public class ZipArchive
{
// Summary:
// Opens a ZipArchive on the specified path for reading. The specified file
// is opened with FileMode.Open.
//
// Parameters:
// path:
// A string specifying the path on the filesystem to open the archive on.
// The path is permitted to specify relative or absolute path information.
// Relative path information is interpreted as relative to the current working
// directory.
//
// Exceptions
// ArgumentException:
// path is a zero-length string, contains only white space, or contains one or
// more invalid characters as defined by InvalidPathChars.
// ArgumentNullException:
// path is null.
// PathTooLongException:
// The specified path, file name, or both exceed the system-defined maximum
// length. For example, on Windows-based platforms, paths must be less than
// 248 characters, and file names must be less than 260 characters.
// DirectoryNotFoundException:
// The specified path is invalid, (for example, it is on an unmapped drive).
// IOException:
// An I/O error occurred while opening the file.
// UnauthorizedAccessException:
// path specified a directory.
// -or-
// The caller does not have the required permission.
// FileNotFoundException:
// The file specified in path was not found.
// NotSupportedException:
// path is in an invalid format.
// InvalidDataException:
// The specified file could not be interpreted as a Zip file.
public ZipArchive(String path);

// Summary:
// Opens a ZipArchive on the specified path in the specified ZipArchiveMode mode.
//
// Parameters:
// path:
// A string specifying the path on the filesystem to open the archive on.
// The path is permitted to specify relative or absolute path information.
// Relative path information is interpreted as relative to the current working
// directory.
// mode:
// See the description of the ZipArchiveMode enum. If Read is specified, the
// file is opened with System.IO.FileMode.Open, and will throw a FileNotFoundException
// if the file does not exist. If Create is specified, the file is opened with
// System.IO.FileMode.CreateNew, and will throw a System.IO.IOException if the
// file already exists. If Update is specified, the file is opened with
// System.IO.FileMode.OpenOrCreate. If the file exists and is Zip file, its entries
// will become accessible, and may be modified, and new entries may be created.
// If the file exists and is not a Zip file, a ZipArchiveException will be thrown.
// If the file exists and is empty or does not exist, a new Zip file will be created.
// Note that creating a Zip file with the ZipArchiveMode.Create mode is more efficient
// when creating a new Zip file.
//
// Exceptions
// ArgumentException:
// path is a zero-length string, contains only white space, or contains one or more
// invalid characters as defined by InvalidPathChars.
// ArgumentNullException:
// path is null.
// PathTooLongException:
// The specified path, file name, or both exceed the system-defined maximum length.
// For example, on Windows-based platforms, paths must be less than 248 characters,
// and file names must be less than 260 characters.
// DirectoryNotFoundException:
// The specified path is invalid, (for example, it is on an unmapped drive).
// IOException:
// An I/O error occurred while opening the file.
// UnauthorizedAccessException:
// path specified a directory.
// -or-
// The caller does not have the required permission.
// ArgumentOutOfRangeException:
// mode specified an invalid value.
// FileNotFoundException:
// The file specified in path was not found.
// NotSupportedException:
// path is in an invalid format.
// InvalidDataException:
// The specified file could not be interpreted as a Zip file.
// -or-
// mode is Update and an entry is missing from the archive or
// is corrupt and cannot be read.
// -or-
// mode is Update and an entry is too large to fit into memory.
public ZipArchive(String path, ZipArchiveMode mode);

// Summary:
// Initializes a new instance of ZipArchive on the given stream for reading.
//
// Parameters:
// stream:
// The stream containing the archive to be read.
//
// Exceptions
// ArgumentException:
// The stream is already closed or does not support reading.
// ArgumentNullException:
// The stream is null.
// InvalidDataException:
// The contents of the stream could not be interpreted as a Zip archive.
public ZipArchive(Stream stream);

// Summary:
// Initializes a new instance of ZipArchive on the given stream in the specified mode.
//
// Parameters:
// stream:
// The input or output stream.
// mode:
// See the description of the ZipArchiveMode enum. Read requires the stream to support
// reading, Create requires the stream to support writing, and Update requires the
// stream to support reading, writing, and seeking.
//
// Exceptions
// ArgumentException:
// The stream is already closed. -or- mode is incompatible with the capabilities
// of the stream.
// ArgumentNullException:
// The stream is null.
// ArgumentOutOfRangeException:
// mode specified an invalid value.
// InvalidDataException:
// The contents of the stream could not be interpreted as a Zip file.
// -or-
// mode is Update and an entry is missing from the archive or is corrupt and
// cannot be read.
// -or-
// mode is Update and an entry is too large to fit into memory.
public ZipArchive(Stream stream, ZipArchiveMode mode);

// Summary:
// Initializes a new instance of ZipArchive on the given stream in the specified mode,
// specifying whether to leave the stream open.
//
// Parameters:
// stream:
// The input or output stream.
// mode:
// See the description of the ZipArchiveMode enum. Read requires the stream to
// support reading, Create requires the stream to support writing, and Update
// requires the stream to support reading, writing, and seeking.
// leaveOpen:
// true to leave the stream open upon disposing the ZipArchive, otherwise false.
//
// Exceptions
// ArgumentException:
// The stream is already closed.
// -or-
// mode is incompatible with the capabilities of the stream.
// ArgumentNullException:
// The stream is null.
// ArgumentOutOfRangeException:
// mode specified an invalid value.
// InvalidDataException:
// The contents of the stream could not be interpreted as a Zip file.
// -or-
// mode is Update and an entry is missing from the archive or is corrupt and
// cannot be read.
// -or-
// mode is Update and an entry is too large to fit into memory.
public ZipArchive(Stream stream, ZipArchiveMode mode, Boolean leaveOpen);

// Summary:
// The collection of entries that are currently in the ZipArchive. This may not
// accurately represent the actual entries that are present in the underlying file
// or stream.
//
// Exceptions
// NotSupportedException:
// The ZipArchive does not support reading.
// ObjectDisposedException:
// The ZipArchive has already been closed.
// InvalidDataException:
// The Zip archive is corrupt and the entries cannot be retrieved.
public ReadOnlyCollection<ZipArchiveEntry> Entries;

// Summary:
// The ZipArchiveMode that the ZipArchive was initialized with.
public ZipArchiveMode Mode;

// Summary:
// Releases the unmanaged resources used by ZipArchive and optionally finishes
// writing the archive and releases the managed resources.
//
// Parameters:
// disposing:
// true to finish writing the archive and release unmanaged and managed resources,
// false to release only unmanaged resources.
protected virtual void Dispose(Boolean disposing);

// Summary:
// Creates an empty entry in the Zip archive with the specified entry name. There
// are no restrictions on the names of entries. The last write time of the entry
// is set to the current time. If an entry with the specified name already exists
// in the archive, a second entry will be created that has an identical name.
//
// Parameters:
// entryName:
// A path relative to the root of the archive, indicating the name of the
// entry to be created.
//
// Exceptions
// ArgumentException:
// entryName is a zero-length string.
// ArgumentNullException:
// entryName is null.
// NotSupportedException:
// The ZipArchive does not support writing.
// ObjectDisposedException:
// The ZipArchive has already been closed.
//
// Returns:
// A wrapper for the newly created file entry in the archive.
public ZipArchiveEntry CreateEntry(String entryName);

// Summary:
// Finishes writing the archive and releases all resources used by the ZipArchive
// object, unless the object was constructed with leaveOpen as true. Any streams
// from opened entries in the ZipArchive still open will throw exceptions on
// subsequent writes, as the underlying streams will have been closed.
public void Dispose();

// Summary:
// Retrieves a wrapper for the file entry in the archive with the specified name.
// Names are compared using ordinal comparison. If there are multiple entries in
// the archive with the specified name, the first one found will be returned.
//
// Parameters:
// entryName:
// A path relative to the root of the archive, identifying the desired entry.
//
// Exceptions
// ArgumentException:
// entryName is a zero-length string.
// ArgumentNullException:
// entryName is null.
// NotSupportedException:
// The ZipArchive does not support reading.
// ObjectDisposedException:
// The ZipArchive has already been closed.
// InvalidDataException:
// The Zip archive is corrupt and the entries cannot be retrieved.
//
// Returns:
// A wrapper for the file entry in the archive. If no entry in the archive exists
// with the specified name, null will be returned.
public ZipArchiveEntry GetEntry(String entryName);

// Summary:
// Adds a file from the file system to the archive under the specified entry name.
// The new entry in the archive will contain the contents of the file. The last
// write time of the archive entry is set to the last write time of the file on
// the file system. If an entry with the specified name already exists in the
// archive, a second entry will be created that has an identical name. If the
// specified source file has an invalid last modified time, the first datetime
// representable in the Zip timestamp format (midnight on January 1, 1980) will
// be used.
//
// Parameters:
// sourceFileName:
// The path to the file on the file system to be copied from. The path is
// permitted to specify relative or absolute path information. Relative path
// information is interpreted as relative to the current working directory.
// entryName:
// The name of the entry to be created.
//
// Exceptions
// ArgumentException:
// sourceFileName is a zero-length string, contains only white space, or
// contains one or more invalid characters as defined by InvalidPathChars.
// -or-
// entryName is a zero-length string.
// ArgumentNullException:
// sourceFileName or entryName is null.
// PathTooLongException:
// In sourceFileName, the specified path, file name, or both exceed the
// system-defined maximum length. For example, on Windows-based platforms,
// paths must be less than 248 characters, and file names must be less than
// 260 characters.
// DirectoryNotFoundException:
// The specified sourceFileName is invalid, (for example, it is on an
// unmapped drive).
// IOException:
// An I/O error occurred while opening the file specified by sourceFileName.
// UnauthorizedAccessException:
// sourceFileName specified a directory.
// -or-
// The caller does not have the required permission.
// FileNotFoundException:
// The file specified in sourceFileName was not found.
// NotSupportedException:
// sourceFileName is in an invalid format or the ZipArchive does not support
// writing.
// ObjectDisposedException:
// The ZipArchive has already been closed.
//
// Returns:
// A wrapper for the newly created entry.
public ZipArchiveEntry CreateEntryFromFile(String sourceFileName, String entryName);

// Summary:
// Extracts all of the files in the archive to a directory on the file system.
// The specified directory must not exist. This method will create all subdirectories
// and the specified directory. If there is an error while extracting the archive,
// the archive will remain partially extracted. Each entry will be extracted such
// that the extracted file has the same relative path to destinationDirectoryName
// as the entry has to the root of the archive. If a file to be archived has an
// invalid last modified time, the first datetime representable in the Zip timestamp
// format (midnight on January 1, 1980) will be used.
//
// Parameters:
// destinationDirectoryName:
// The path to the directory on the file system. The directory specified must not
// exist. The path is permitted to specify relative or absolute path information.
// Relative path information is interpreted as relative to the current working
// directory.
//
// Exceptions
// ArgumentException:
// destinationDirectoryName is a zero-length string, contains only white space,
// or contains one or more invalid characters as defined by InvalidPathChars.
// ArgumentNullException:
// destinationDirectoryName is null.
// PathTooLongException:
// The specified path, file name, or both exceed the system-defined maximum
// length. For example, on Windows-based platforms, paths must be less than
// 248 characters, and file names must be less than 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-
// An archive entry’s name is zero-length, contains only white space, or contains
// one or more invalid characters as defined by InvalidPathChars.
// -or-
// Extracting an archive entry would have resulted in a destination file that is
// outside destinationDirectoryName (for example, if the entry name contains
// parent directory accessors).
// -or-
// An archive entry has the same name as an already extracted entry from the
// same archive.
// UnauthorizedAccessException:
// The caller does not have the required permission.
// NotSupportedException:
// destinationDirectoryName is in an invalid format.
// InvalidDataException:
// An archive entry was not found or was corrupt.
// -or-
// An archive entry has been compressed using a compression method that is not
// supported.
public void ExtractToDirectory(String destinationDirectoryName);

// Summary:
// Creates a Zip archive at the path destinationArchive that contains the files and
// directories in the directory specified by sourceDirectoryName. The directory
// structure is preserved in the archive, and a recursive search is done for files
// to be archived. The archive must not exist. If the directory is empty, an empty
// archive will be created. If a file in the directory cannot be added to the archive,
// the archive will be left incomplete and invalid and the method will throw an
// exception. This method optionally includes the base directory in the archive.
// If an error is encountered while adding files to the archive, this method will
// stop adding files and leave the archive in an invalid state. The paths are
// permitted to specify relative or absolute path information. Relative path
// information is interpreted as relative to the current working directory. If a
// file in the archive has data in the last write time field that is not a valid
// Zip timestamp, an indicator value of 1980 January 1 at midnight will be used for
// the file’s last modified time.
//
// Parameters:
// sourceDirectoryName:
// The path to the directory on the file system to be archived.
// destinationArchive:
// The name of the archive to be created.
// includeBaseDirectory:
// True to indicate that a directory named sourceDirectoryName should be included
// at the root of the archive. False to indicate that the files and directories
// in sourceDirectoryName should be included directly in the archive.
//
// Exceptions
// ArgumentException:
// sourceDirectoryName or destinationArchive is a zero-length string, contains
// only white space, or contains one or more invalid characters as defined by
// InvalidPathChars.
// ArgumentNullException:
// sourceDirectoryName or destinationArchive is null.
// PathTooLongException:
// In sourceDirectoryName or destinationArchive, the specified path, file name,
// or both exceed the system-defined maximum length. For example, on Windows
// based platforms, paths must be less than 248 characters, and file names
// must be less than 260 characters.
// DirectoryNotFoundException:
// The path specified in sourceDirectoryName or destinationArchive is invalid,
// (for example, it is on an unmapped drive).
// -or-
// The directory specified by sourceDirectoryName does not exist.
// IOException:
// destinationArchive exists.
// -or-
// An I/O error occurred while opening a file to be archived.
// UnauthorizedAccessException:
// destinationArchive specified a directory.
// -or-
// The caller does not have the required permission.
// NotSupportedException:
// sourceDirectoryName or destinationArchive is in an invalid format.
public static void CreateFromDirectory(String sourceDirectoryName,
String destinationArchive,
Boolean includeBaseDirectory);

// Summary:
// Creates a Zip archive at the path destinationArchive that contains the files
// and directories in the directory specified by sourceDirectoryName. The directory
// structure is preserved in the archive, and a recursive search is done for files
// to be archived. The archive must not exist. If the directory is empty, an empty
// archive will be created. If a file in the directory cannot be added to the
// archive, the archive will be left incomplete and invalid and the method will
// throw an exception. This method does not include the base directory in the archive.
// If an error is encountered while adding files to the archive, this method will
// stop adding files and leave the archive in an invalid state. The paths are
// permitted to specify relative or absolute path information. Relative path
// information is interpreted as relative to the current working directory. If a
// file in the archive has data in the last write time field that is not a valid Zip
// timestamp, an indicator value of 1980 January 1 at midnight will be used for the
// file’s last modified time.
//
// Parameters:
// sourceDirectoryName:
// The path to the directory on the file system to be archived.
// destinationArchive:
// The name of the archive to be created.
//
// Exceptions
// ArgumentException:
// sourceDirectoryName or destinationArchive is a zero-length string, contains
// only white space, or contains one or more invalid characters as defined by
// InvalidPathChars.
// ArgumentNullException:
// sourceDirectoryName or destinationArchive is null.
// PathTooLongException:
// In sourceDirectoryName or destinationArchive, the specified path, file name,
// or both exceed the system-defined maximum length. For example, on Windows-based
// platforms, paths must be less than 248 characters, and file names must be less
// than 260 characters.
// DirectoryNotFoundException:
// The path specified in sourceDirectoryName or destinationArchive is invalid,
// (for example, it is on an unmapped drive).
// -or-
// The directory specified by sourceDirectoryName does not exist.
// IOException:
// destinationArchive exists.
// -or-
// An I/O error occurred while opening a file to be archived.
// UnauthorizedAccessException:
// destinationArchive specified a directory.
// -or-
// The caller does not have the required permission.
// NotSupportedException:
// sourceDirectoryName or destinationArchive is in an invalid format.
public static void CreateFromDirectory(String sourceDirectoryName, String destinationArchive);

// Summary:
// Extracts all of the files in the specified archive to a directory on the file
// system. The specified directory must not exist. This method will create all
// subdirectories and the specified directory. If there is an error while extracting
// the archive, the archive will remain partially extracted. Each entry will be
// extracted such that the extracted file has the same relative path to the
// destinationDirectoryName as the entry has to the archive. The path is permitted
// to specify relative or absolute path information. Relative path information is
// interpreted as relative to the current working directory. If a file to be archived
// has an invalid last modified time, the first datetime representable in the Zip
// timestamp format (midnight on January 1, 1980) will be used.
//
// Parameters:
// sourceArchive:
// The path to the archive on the file system that is to be extracted.
// destinationDirectoryName:
// The path to the directory on the file system. The directory specified must
// not exist, but the directory that it is contained in must exist.
//
// Exceptions
// ArgumentException:
// sourceArchive or destinationDirectoryName is a zero-length string, contains
// only white space, or contains one or more invalid characters as defined by
// InvalidPathChars.
// ArgumentNullException:
// sourceArchive or destinationDirectoryName is null.
// PathTooLongException:
// sourceArchive or destinationDirectoryName specifies a path, file name, or
// both exceed the system-defined maximum length. For example, on Windows-based
// platforms, paths must be less than 248 characters, and file names must be less
// than 260 characters.
// DirectoryNotFoundException:
// The path specified by sourceArchive or destinationDirectoryName is invalid,
// (for example, it is on an unmapped drive).
// IOException:
// The directory specified by destinationDirectoryName already exists.
// -or-
// An I/O error has occurred.
// -or-
// An archive entry’s name is zero-length, contains only white space, or
// contains one or more invalid characters as defined by InvalidPathChars.
// -or-
// Extracting an archive entry would result in a file destination that is
// outside the destination directory (for example, because of parent directory
// accessors).
// -or-
// An archive entry has the same name as an already extracted entry from the
// same archive.
// UnauthorizedAccessException:
// The caller does not have the required permission.
// NotSupportedException:
// sourceArchive or destinationDirectoryName is in an invalid format.
// FileNotFoundException:
// sourceArchive was not found.
// InvalidDataException:
// The archive specified by sourceArchive: Is not a valid ZipArchive
// -or-
// An archive entry was not found or was corrupt.
// -or-
// An archive entry has been compressed using a compression method that is
// not supported.
public static void ExtractToDirectory(String sourceArchive, String destinationDirectoryName);
}
}

ZipArchiveEntry Class

namespace Microsoft.Experimental.IO.Compression
{
    public class ZipArchiveEntry
    {
        // Summary:
        //     The last write time of the entry as stored in the Zip archive.
        //     When setting this property, the DateTime will be converted to
        //     the Zip timestamp format, which supports a resolution of two
        //     seconds. If the data in the last write time field is not a
        //     valid Zip timestamp, an indicator value of 1980 January 1
        //     at midnight will be returned.
        //
        // Exceptions:
        //     NotSupportedException:
        //         An attempt to set this property was made, but the ZipArchive
        //         that this entry belongs to was opened in read-only mode.
        //     ArgumentOutOfRangeException:
        //         An attempt was made to set this property to a value that
        //         cannot be represented in the Zip timestamp format. The
        //         earliest date/time that can be represented is 1980
        //         January 1 0:00:00 (midnight), and the last date/time that
        //         can be represented is 2107 December 31 23:59:58 (one second
        //         before midnight).
        public DateTimeOffset LastWriteTime;

        // Summary:
        //     The relative path of the entry as stored in the Zip archive.
        //     Note that Zip archives allow any string to be the path of the
        //     entry, including invalid and absolute paths.
        public String FullName;

        // Summary:
        //     The filename of the entry. This is equivalent to the substring
        //     of Fullname that follows the final directory separator character.
        public String Name;

        // Summary:
        //     The compressed size of the entry. If the archive that the entry
        //     belongs to is in Create mode, attempts to get this property will
        //     always throw an exception. If the archive that the entry belongs
        //     to is in update mode, this property will only be valid if the
        //     entry has not been opened. 
        //
        // Exceptions:
        //     InvalidOperationException:
        //         This property is not available because the entry has been
        //         written to or modified.
        public Int64 CompressedLength;

        // Summary:
        //     The uncompressed size of the entry. This property is not valid
        //     in Create mode, and it is only valid in Update mode if the entry
        //     has not been opened.
        //
        // Exceptions:
        //     InvalidOperationException:
        //         This property is not available because the entry has been
        //         written to or modified.
        public Int64 Length;

        // Summary:
        //     The ZipArchive that this entry belongs to. If this entry has
        //     been deleted, this will return null.
        public ZipArchive Archive;

        // Summary:
        //     Opens the entry. If the archive that the entry belongs to was
        //     opened in Read mode, the returned stream will be readable, and
        //     it may or may not be seekable. If Create mode, the returned stream
        //     will be writeable and not seekable. If Update mode, the returned
        //     stream will be readable, writeable, seekable, and support SetLength.
        //
        // Exceptions:
        //     IOException:
        //         The entry is already currently open for writing.
        //         -or-
        //         The entry has been deleted from the archive.
        //         -or-
        //         The archive that this entry belongs to was opened in
        //         ZipArchiveMode.Create, and this entry has already been written
        //         to once.
        //     InvalidDataException:
        //         The entry is missing from the archive or is corrupt and cannot
        //         be read.
        //         -or-
        //         The entry has been compressed using a compression method that
        //         is not supported.
        //     ObjectDisposedException:
        //         The ZipArchive that this entry belongs to has been disposed.
        // 
        // Returns:
        //     A Stream that represents the contents of the entry.
        public Stream Open();

        // Summary:
        //     Deletes the entry from the archive.
        //
        // Exceptions:
        //     IOException:
        //         The entry is already open for reading or writing.
        //     NotSupportedException:
        //         The ZipArchive that this entry belongs to was opened in a mode
        //         other than ZipArchiveMode.Update. 
        //     ObjectDisposedException:
        //         The ZipArchive that this entry belongs to has been disposed.
        public void Delete();

        // Summary:
        //     Returns the FullName of the entry.
        // 
        // Returns:
        //     FullName of the entry
        public override String ToString();

        // Summary:
        //     Creates a file on the file system with the entry’s contents and the
        //     specified name. The last write time of the file is set to the
        //     entry’s last write time. This method does allows overwriting of
        //     an existing file with the same name.
        // 
        // Parameters:
        //     destinationFileName:
        //         The name of the file that will hold the contents of the entry.
        //         The path is permitted to specify relative or absolute path
        //         information. Relative path information is interpreted as
        //         relative to the current working directory.
        //     overwrite:
        //         True to indicate overwrite.
        // 
        // Exceptions:
        //     UnauthorizedAccessException:
        //         The caller does not have the required permission.
        //     ArgumentException:
        //         destinationFileName is a zero-length string, contains only
        //         white space, or contains one or more invalid characters as
        //         defined by InvalidPathChars.
        //         -or-
        //         destinationFileName specifies a directory.
        //     ArgumentNullException:
        //         destinationFileName is null.
        //     PathTooLongException:
        //         The specified path, file name, or both exceed the system-
        //         defined maximum length. For example, on Windows-based platforms,
        //         paths must be less than 248 characters, and file names must be
        //         less than 260 characters.
        //     DirectoryNotFoundException:
        //         The path specified in destinationFileName is invalid (for example,
        //         it is on an unmapped drive).
        //     IOException:
        //         destinationFileName exists and overwrite is false.
        //         -or-
        //         An I/O error has occurred.
        //         -or-
        //         The entry is currently open for writing.
        //         -or-
        //         The entry has been deleted from the archive.
        //     NotSupportedException:
        //         destinationFileName is in an invalid format
        //         -or-
        //         The ZipArchive that this entry belongs to was opened in a
        //         write-only mode.
        //     InvalidDataException:
        //         The entry is missing from the archive or is corrupt and cannot
        //         be read
        //         -or-
        //         The entry has been compressed using a compression method that
        //         is not supported.
        //     ObjectDisposedException:
        //         The ZipArchive that this entry belongs to has been disposed.
        public void ExtractToFile(String destinationFileName, Boolean overwrite);

        // Summary:
        //     Creates a file on the file system with the entry’s contents and the
        //     specified name. The last write time of the file is set to the entry’s
        //     last write time. This method does not allow overwriting of an existing
        //     file with the same name. Attempting to extract explicit directories
        //     (entries with names that end in directory separator characters) will
        //     not result in the creation of a directory.
        // 
        // Parameters:
        //     destinationFileName:
        //         The name of the file that will hold the contents of the entry.
        //         The path is permitted to specify relative or absolute path
        //         information. Relative path information is interpreted as
        //         relative to the current working directory.
        // 
        // Exceptions:
        //     UnauthorizedAccessException:
        //         The caller does not have the required permission.
        //     ArgumentException:
        //         destinationFileName is a zero-length string, contains only white
        //         space, or contains one or more invalid characters as defined by
        //         InvalidPathChars.
        //         -or-
        //         destinationFileName specifies a directory.
        //     ArgumentNullException:
        //         destinationFileName is null.
        //     PathTooLongException:
        //         The specified path, file name, or both exceed the system-defined
        //         maximum length. For example, on Windows-based platforms, paths
        //         must be less than 248 characters, and file names must be less
        //         than 260 characters.
        //     DirectoryNotFoundException:
        //         The path specified in destinationFileName is invalid (for example,
        //         it is on an unmapped drive).
        //     IOException:
        //         destinationFileName exists.
        //         -or-
        //         An I/O error has occurred.
        //         -or-
        //         The entry is currently open for writing.
        //         -or-
        //         The entry has been deleted from the archive.
        //     NotSupportedException:
        //         destinationFileName is in an invalid format
        //         -or-
        //         The ZipArchive that this entry belongs to was opened in a
        //         write-only mode.
        //     InvalidDataException:
        //         The entry is missing from the archive or is corrupt and cannot
        //         be read
        //         -or-
        //         The entry has been compressed using a compression method that
        //         is not supported.
        //     ObjectDisposedException:
        //         The ZipArchive that this entry belongs to has been disposed.
        public void ExtractToFile(String destinationFileName);
    }
}

ZipArchiveMode Enum

namespace Microsoft.Experimental.IO.Compression
{
    public enum ZipArchiveMode
    {
        // Summary:
        //     Only reading entries from the archive is permitted. If the underlying
        //     file or stream is seekable, then files will be read from the archive
        //     on-demand as they are requested. If the underlying file or stream is not
        //     seekable, the entire archive will be held in memory. Requires that the
        //     underlying file or stream is readable.
        Read,

        // Summary:
        //     Only supports the creation of new archives. Only writing to newly created
        //     entries in the archive is permitted. Each entry in the archive can only
        //     be opened for writing once. If only one entry is written to at a time, data
        //     will be written to the underlying stream or file as soon as it is available.
        //     The underlying stream must be writeable, but need not be seekable.
        Create,

        // Summary:
        //     Reading and writing from entries in the archive is permitted. Requires that
        //     the contents of the entire archive be held in memory. The underlying file
        //     or stream must be readable, writeable and seekable. No data will be written
        //     to the underlying file or stream until the archive is disposed.
        Update
    }
}

Updated Wiki: ZipArchive Class Reference

hrlee — Fri, 06 Aug 2010 22:49:10 GMT

ZipArchive Class

// Summary:
// The ZipArchiveMode that the ZipArchive was initialized with.
public ZipArchiveMode Mode;

ZipArchiveEntry Class

namespace Microsoft.Experimental.IO.Compression
{
    public class ZipArchiveEntry
    {
        // Summary:
        //     The last write time of the entry as stored in the Zip archive.
        //     When setting this property, the DateTime will be converted to
        //     the Zip timestamp format, which supports a resolution of two
        //     seconds. If the data in the last write time field is not a
        //     valid Zip timestamp, an indicator value of 1980 January 1
        //     at midnight will be returned.
        //
        // Exceptions:
        //     NotSupportedException:
        //         An attempt to set this property was made, but the ZipArchive
        //         that this entry belongs to was opened in read-only mode.
        //     ArgumentOutOfRangeException:
        //         An attempt was made to set this property to a value that
        //         cannot be represented in the Zip timestamp format. The
        //         earliest date/time that can be represented is 1980
        //         January 1 0:00:00 (midnight), and the last date/time that
        //         can be represented is 2107 December 31 23:59:58 (one second
        //         before midnight).
        public DateTimeOffset LastWriteTime;

        // Summary:
        //     The relative path of the entry as stored in the Zip archive.
        //     Note that Zip archives allow any string to be the path of the
        //     entry, including invalid and absolute paths.
        public String FullName;

        // Summary:
        //     The filename of the entry. This is equivalent to the substring
        //     of Fullname that follows the final directory separator character.
        public String Name;

        // Summary:
        //     The compressed size of the entry. If the archive that the entry
        //     belongs to is in Create mode, attempts to get this property will
        //     always throw an exception. If the archive that the entry belongs
        //     to is in update mode, this property will only be valid if the
        //     entry has not been opened. 
        //
        // Exceptions:
        //     InvalidOperationException:
        //         This property is not available because the entry has been
        //         written to or modified.
        public Int64 CompressedLength;

        // Summary:
        //     The uncompressed size of the entry. This property is not valid
        //     in Create mode, and it is only valid in Update mode if the entry
        //     has not been opened.
        //
        // Exceptions:
        //     InvalidOperationException:
        //         This property is not available because the entry has been
        //         written to or modified.
        public Int64 Length;

        // Summary:
        //     The ZipArchive that this entry belongs to. If this entry has
        //     been deleted, this will return null.
        public ZipArchive Archive;

        // Summary:
        //     Opens the entry. If the archive that the entry belongs to was
        //     opened in Read mode, the returned stream will be readable, and
        //     it may or may not be seekable. If Create mode, the returned stream
        //     will be writeable and not seekable. If Update mode, the returned
        //     stream will be readable, writeable, seekable, and support SetLength.
        //
        // Exceptions:
        //     IOException:
        //         The entry is already currently open for writing.
        //         -or-
        //         The entry has been deleted from the archive.
        //         -or-
        //         The archive that this entry belongs to was opened in
        //         ZipArchiveMode.Create, and this entry has already been written
        //         to once.
        //     InvalidDataException:
        //         The entry is missing from the archive or is corrupt and cannot
        //         be read.
        //         -or-
        //         The entry has been compressed using a compression method that
        //         is not supported.
        //     ObjectDisposedException:
        //         The ZipArchive that this entry belongs to has been disposed.
        // 
        // Returns:
        //     A Stream that represents the contents of the entry.
        public Stream Open();

        // Summary:
        //     Deletes the entry from the archive.
        //
        // Exceptions:
        //     IOException:
        //         The entry is already open for reading or writing.
        //     NotSupportedException:
        //         The ZipArchive that this entry belongs to was opened in a mode
        //         other than ZipArchiveMode.Update. 
        //     ObjectDisposedException:
        //         The ZipArchive that this entry belongs to has been disposed.
        public void Delete();

        // Summary:
        //     Returns the FullName of the entry.
        // 
        // Returns:
        //     FullName of the entry
        public override String ToString();

        // Summary:
        //     Creates a file on the file system with the entry’s contents and the
        //     specified name. The last write time of the file is set to the
        //     entry’s last write time. This method does allows overwriting of
        //     an existing file with the same name.
        // 
        // Parameters:
        //     destinationFileName:
        //         The name of the file that will hold the contents of the entry.
        //         The path is permitted to specify relative or absolute path
        //         information. Relative path information is interpreted as
        //         relative to the current working directory.
        //     overwrite:
        //         True to indicate overwrite.
        // 
        // Exceptions:
        //     UnauthorizedAccessException:
        //         The caller does not have the required permission.
        //     ArgumentException:
        //         destinationFileName is a zero-length string, contains only
        //         white space, or contains one or more invalid characters as
        //         defined by InvalidPathChars.
        //         -or-
        //         destinationFileName specifies a directory.
        //     ArgumentNullException:
        //         destinationFileName is null.
        //     PathTooLongException:
        //         The specified path, file name, or both exceed the system-
        //         defined maximum length. For example, on Windows-based platforms,
        //         paths must be less than 248 characters, and file names must be
        //         less than 260 characters.
        //     DirectoryNotFoundException:
        //         The path specified in destinationFileName is invalid (for example,
        //         it is on an unmapped drive).
        //     IOException:
        //         destinationFileName exists and overwrite is false.
        //         -or-
        //         An I/O error has occurred.
        //         -or-
        //         The entry is currently open for writing.
        //         -or-
        //         The entry has been deleted from the archive.
        //     NotSupportedException:
        //         destinationFileName is in an invalid format
        //         -or-
        //         The ZipArchive that this entry belongs to was opened in a
        //         write-only mode.
        //     InvalidDataException:
        //         The entry is missing from the archive or is corrupt and cannot
        //         be read
        //         -or-
        //         The entry has been compressed using a compression method that
        //         is not supported.
        //     ObjectDisposedException:
        //         The ZipArchive that this entry belongs to has been disposed.
        public void ExtractToFile(String destinationFileName, Boolean overwrite);

        // Summary:
        //     Creates a file on the file system with the entry’s contents and the
        //     specified name. The last write time of the file is set to the entry’s
        //     last write time. This method does not allow overwriting of an existing
        //     file with the same name. Attempting to extract explicit directories
        //     (entries with names that end in directory separator characters) will
        //     not result in the creation of a directory.
        // 
        // Parameters:
        //     destinationFileName:
        //         The name of the file that will hold the contents of the entry.
        //         The path is permitted to specify relative or absolute path
        //         information. Relative path information is interpreted as
        //         relative to the current working directory.
        // 
        // Exceptions:
        //     UnauthorizedAccessException:
        //         The caller does not have the required permission.
        //     ArgumentException:
        //         destinationFileName is a zero-length string, contains only white
        //         space, or contains one or more invalid characters as defined by
        //         InvalidPathChars.
        //         -or-
        //         destinationFileName specifies a directory.
        //     ArgumentNullException:
        //         destinationFileName is null.
        //     PathTooLongException:
        //         The specified path, file name, or both exceed the system-defined
        //         maximum length. For example, on Windows-based platforms, paths
        //         must be less than 248 characters, and file names must be less
        //         than 260 characters.
        //     DirectoryNotFoundException:
        //         The path specified in destinationFileName is invalid (for example,
        //         it is on an unmapped drive).
        //     IOException:
        //         destinationFileName exists.
        //         -or-
        //         An I/O error has occurred.
        //         -or-
        //         The entry is currently open for writing.
        //         -or-
        //         The entry has been deleted from the archive.
        //     NotSupportedException:
        //         destinationFileName is in an invalid format
        //         -or-
        //         The ZipArchive that this entry belongs to was opened in a
        //         write-only mode.
        //     InvalidDataException:
        //         The entry is missing from the archive or is corrupt and cannot
        //         be read
        //         -or-
        //         The entry has been compressed using a compression method that
        //         is not supported.
        //     ObjectDisposedException:
        //         The ZipArchive that this entry belongs to has been disposed.
        public void ExtractToFile(String destinationFileName);
    }
}

ZipArchiveMode Enum

namespace Microsoft.Experimental.IO.Compression
{
    public enum ZipArchiveMode
    {
        // Summary:
        //     Only reading entries from the archive is permitted. If the underlying
        //     file or stream is seekable, then files will be read from the archive
        //     on-demand as they are requested. If the underlying file or stream is not
        //     seekable, the entire archive will be held in memory. Requires that the
        //     underlying file or stream is readable.
        Read,

        // Summary:
        //     Only supports the creation of new archives. Only writing to newly created
        //     entries in the archive is permitted. Each entry in the archive can only
        //     be opened for writing once. If only one entry is written to at a time, data
        //     will be written to the underlying stream or file as soon as it is available.
        //     The underlying stream must be writeable, but need not be seekable.
        Create,

        // Summary:
        //     Reading and writing from entries in the archive is permitted. Requires that
        //     the contents of the entire archive be held in memory. The underlying file
        //     or stream must be readable, writeable and seekable. No data will be written
        //     to the underlying file or stream until the archive is disposed.
        Update
    }
}

Updated Wiki: ZipArchive Samples

hrlee — Fri, 06 Aug 2010 20:06:29 GMT

ZipArchive Samples

Zipping/unzipping directories

If you just want to extract an archive to a directory or create an archive from a directory, a single line of code is all you need:

ZipArchive.ExtractToDirectory("photos.zip", @"photos\summer2010");

ZipArchive.CreateFromDirectory(@"docs\attach", "attachment.zip");

More advanced manipulation

If you need more sophisticated manipulation of Zip archives, the ZipArchive and ZipArchiveEntry classes need to be used together. The following example extracts only the text files from an archive:

using (var archive = new ZipArchive("data.zip"))
{
    foreach (var entry in archive.Entries)
    {
        if (entry.FullName.EndsWith(".txt", StringComparison.OrdinalIgnoreCase))
        {
            entry.ExtractToFile(Path.Combine(directory, entry.FullName));
        }
    }
}

The following sample creates an archive containing one file from the filesystem, and also generates an index of what's included in the archive on the fly:

using (var archive = new ZipArchive("new.zip", ZipArchiveMode.Create))
{
    var readmeEntry = archive.CreateEntry("Readme.txt");
    using (var writer = new StreamWriter(readmeEntry.Open()))
    {
        writer.WriteLine("Included files: ");
        writer.WriteLine("data.dat");
    }

    archive.CreateEntryFromFile("data.dat", "data.dat");
}

If you don't want to (or can't) touch the filesystem, ZipArchive can work with just streams. The following sample creates an archive on the output stream that contains one file whose contents are the input stream:

using (ZipArchive archive = new ZipArchive(outstream, ZipArchiveMode.Create))
{
    ZipArchiveEntry entry = archive.CreateEntry("data.dat");
    using (Stream entryStream = entry.Open())
    {
        instream.CopyTo(entryStream);
    }
}

ZipArchiveModes

As shown in the samples above, there are different ZipArchiveMode values that tell the ZipArchive constructor to behave in different ways. Read (the default) provides read-only access. Create allows the creation of archives with some restrictions. For example, in Create mode opening two entries at the same time is an error - the first one must be opened, written to, and then closed before the next one is opened. Update, which was not used in any of the samples, allows arbitrary manipulations of archives. The downside to Update mode is that providing this functionality requires loading the entire archive into memory. Read and Create mode, on the other hand, read and write directly from the underlying store with only a small buffer.

Updated Wiki: ZipArchive Samples

hrlee — Fri, 06 Aug 2010 20:06:28 GMT

ZipArchive Samples

Zipping/unzipping directories

If you just want to extract an archive to a directory or create an archive from a directory, a single line of code is all you need:

ZipArchive.ExtractToDirectory("photos.zip", @"photos\summer2010");

ZipArchive.CreateFromDirectory(@"docs\attach", "attachment.zip");

More advanced manipulation

If you need more sophisticated manipulation of Zip archives, the ZipArchive and ZipArchiveEntry classes need to be used together. The following example extracts only the text files from an archive:

using (var archive = new ZipArchive("data.zip"))
{
    foreach (var entry in archive.Entries)
    {
        if (entry.FullName.EndsWith(".txt", StringComparison.OrdinalIgnoreCase))
        {
            entry.ExtractToFile(Path.Combine(directory, entry.FullName));
        }
    }
}

The following sample creates an archive containing one file from the filesystem, and also generates an index of what's included in the archive on the fly:

using (var archive = new ZipArchive("new.zip", ZipArchiveMode.Create))
{
    var readmeEntry = archive.CreateEntry("Readme.txt");
    using (var writer = new StreamWriter(readmeEntry.Open()))
    {
        writer.WriteLine("Included files: ");
        writer.WriteLine("data.dat");
    }

    archive.CreateEntryFromFile("data.dat", "data.dat");
}

using (ZipArchive archive = new ZipArchive(outstream, ZipArchiveMode.Create))
{
    ZipArchiveEntry entry = archive.CreateEntry("data.dat");
    using (Stream entryStream = entry.Open())
    {
        instream.CopyTo(entryStream);
    }
}

ZipArchiveModes

Updated Wiki: ZipArchive Samples

hrlee — Fri, 06 Aug 2010 20:06:28 GMT

ZipArchive Samples

Zipping/unzipping directories

If you just want to extract an archive to a directory or create an archive from a directory, a single line of code is all you need:

ZipArchive.ExtractToDirectory("photos.zip", @"photos\summer2010");

ZipArchive.CreateFromDirectory(@"docs\attach", "attachment.zip");

More advanced manipulation

If you need more sophisticated manipulation of Zip archives, the ZipArchive and ZipArchiveEntry classes need to be used together. The following example extracts only the text files from an archive:

using (var archive = new ZipArchive("data.zip"))
{
    foreach (var entry in archive.Entries)
    {
        if (entry.FullName.EndsWith(".txt", StringComparison.OrdinalIgnoreCase))
        {
            entry.ExtractToFile(Path.Combine(directory, entry.FullName));
        }
    }
}

The following sample creates an archive containing one file from the filesystem, and also generates an index of what's included in the archive on the fly:

using (var archive = new ZipArchive("new.zip", ZipArchiveMode.Create))
{
    var readmeEntry = archive.CreateEntry("Readme.txt");
    using (var writer = new StreamWriter(readmeEntry.Open()))
    {
        writer.WriteLine("Included files: ");
        writer.WriteLine("data.dat");
    }

    archive.CreateEntryFromFile("data.dat", "data.dat");
}

using (ZipArchive archive = new ZipArchive(outstream, ZipArchiveMode.Create))
{
    ZipArchiveEntry entry = archive.CreateEntry("data.dat");
    using (Stream entryStream = entry.Open())
    {
        instream.CopyTo(entryStream);
    }
}

ZipArchiveModes

Updated Wiki: ZipArchive Samples

hrlee — Fri, 06 Aug 2010 20:06:28 GMT

ZipArchive Samples

Zipping/unzipping directories

If you just want to extract an archive to a directory or create an archive from a directory, a single line of code is all you need:

ZipArchive.ExtractToDirectory("photos.zip", @"photos\summer2010");

ZipArchive.CreateFromDirectory(@"docs\attach", "attachment.zip");

More advanced manipulation

If you need more sophisticated manipulation of Zip archives, the ZipArchive and ZipArchiveEntry classes need to be used together. The following example extracts only the text files from an archive:

using (var archive = new ZipArchive("data.zip"))
{
    foreach (var entry in archive.Entries)
    {
        if (entry.FullName.EndsWith(".txt", StringComparison.OrdinalIgnoreCase))
        {
            entry.ExtractToFile(Path.Combine(directory, entry.FullName));
        }
    }
}

The following sample creates an archive containing one file from the filesystem, and also generates an index of what's included in the archive on the fly:

using (var archive = new ZipArchive("new.zip", ZipArchiveMode.Create))
{
    var readmeEntry = archive.CreateEntry("Readme.txt");
    using (var writer = new StreamWriter(readmeEntry.Open()))
    {
        writer.WriteLine("Included files: ");
        writer.WriteLine("data.dat");
    }

    archive.CreateEntryFromFile("data.dat", "data.dat");
}

using (ZipArchive archive = new ZipArchive(outstream, ZipArchiveMode.Create))
{
    ZipArchiveEntry entry = archive.CreateEntry("data.dat");
    using (Stream entryStream = entry.Open())
    {
        instream.CopyTo(entryStream);
    }
}

bcl Wiki Rss Feed

Updated Wiki: Home

Project Description

Feature Descriptions

Related Sites

Updated Wiki: Home

Project Description

Feature Descriptions

Related Sites

Updated Wiki: PerfMonitor

PerfMonitor

See Also

Having problems?

Updated Wiki: PerfMonitor

PerfMonitor

See Also

Having problems?

Updated Wiki: TraceEvent

TraceEvent

Getting started

See Also

Having problems?

New Comment on "Long Path Samples"

New Comment on "Long Path"

New Comment on "Long Path"

New Comment on "TraceEvent Class Overview"

Updated Wiki: PerfMonitor

PerfMonitor

See Also

Having problems?

New Comment on "Perfmonitor Guide"

Updated Wiki: PerfMonitor

PerfMonitor

See Also

Having problems?

Updated Wiki: ZipArchive

ZipArchive

Getting started

Having problems?

Updated Wiki: ZipArchive

ZipArchive

Getting started

Having problems?

Updated Wiki: ZipArchive Class Reference

ZipArchive Class

ZipArchiveEntry Class

ZipArchiveMode Enum

Updated Wiki: ZipArchive Class Reference

ZipArchive Class

ZipArchiveEntry Class

ZipArchiveMode Enum

Updated Wiki: ZipArchive Samples

ZipArchive Samples

Zipping/unzipping directories

More advanced manipulation

ZipArchiveModes

Updated Wiki: ZipArchive Samples

ZipArchive Samples

Zipping/unzipping directories

More advanced manipulation

ZipArchiveModes

Updated Wiki: ZipArchive Samples

ZipArchive Samples

Zipping/unzipping directories

More advanced manipulation

ZipArchiveModes

Updated Wiki: ZipArchive Samples

ZipArchive Samples

Zipping/unzipping directories

More advanced manipulation

ZipArchiveModes