<Type Name="ZipFile" FullName="System.IO.Compression.ZipFile">

<TypeSignature Language="C#" Value="public static class ZipFile" />

<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit ZipFile extends System.Object" />

<TypeSignature Language="DocId" Value="T:System.IO.Compression.ZipFile" />

<TypeSignature Language="VB.NET" Value="Public Class ZipFile" />

<TypeSignature Language="F#" Value="type ZipFile = class" />

<TypeSignature Language="C++ CLI" Value="public ref class ZipFile abstract sealed" />

<AssemblyInfo>

<AssemblyName>System.IO.Compression.ZipFile</AssemblyName>

<AssemblyVersion>4.0.0.0</AssemblyVersion>

<AssemblyVersion>4.0.1.0</AssemblyVersion>

<AssemblyVersion>4.0.3.0</AssemblyVersion>

<AssemblyVersion>4.0.4.0</AssemblyVersion>

<AssemblyVersion>4.0.5.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<AssemblyInfo>

<AssemblyName>System.IO.Compression.FileSystem</AssemblyName>

<AssemblyVersion>2.0.5.0</AssemblyVersion>

<AssemblyVersion>4.0.0.0</AssemblyVersion>

</AssemblyInfo>

<AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

<AssemblyVersion>2.0.0.0</AssemblyVersion>

<AssemblyVersion>2.1.0.0</AssemblyVersion>

</AssemblyInfo>

<TypeForwardingChain>

<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.IO.Compression.ZipFile" ToVersion="10.0.0.0" FrameworkAlternate="net-10.0" />

<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.IO.Compression.ZipFile" ToVersion="11.0.0.0" FrameworkAlternate="net-11.0" />

<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.IO.Compression.ZipFile" ToVersion="5.0.0.0" FrameworkAlternate="net-5.0" />

<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.IO.Compression.ZipFile" ToVersion="6.0.0.0" FrameworkAlternate="net-6.0" />

<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.IO.Compression.ZipFile" ToVersion="7.0.0.0" FrameworkAlternate="net-7.0" />

<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.IO.Compression.ZipFile" ToVersion="8.0.0.0" FrameworkAlternate="net-8.0" />

<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.IO.Compression.ZipFile" ToVersion="9.0.0.0" FrameworkAlternate="net-9.0" />

</TypeForwardingChain>

<Base>

<BaseTypeName>System.Object</BaseTypeName>

</Base>

<Interfaces />

<Attributes>

<Attribute FrameworkAlternate="net-10.0;net-11.0;net-8.0;net-9.0">

<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>

<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>

</Attribute>

</Attributes>

<Docs>

<summary>Provides static methods for creating, extracting, and opening zip archives.</summary>

<remarks>

<format type="text/markdown"><![CDATA[

]]></format>

</remarks>

</Docs>

<Members>

<MemberGroup MemberName="CreateFromDirectory">

<AssemblyInfo>

<AssemblyName>System.IO.Compression.ZipFile</AssemblyName>

<AssemblyVersion>4.0.1.0</AssemblyVersion>

<AssemblyVersion>4.0.3.0</AssemblyVersion>

</AssemblyInfo>

<Docs>

<summary>Creates a zip archive that contains the files and directories from the specified directory.</summary>

</Docs>

</MemberGroup>

<Member MemberName="CreateFromDirectory">

<MemberSignature Language="C#" Value="public static void CreateFromDirectory (string sourceDirectoryName, System.IO.Stream destination);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig void CreateFromDirectory(string sourceDirectoryName, class System.IO.Stream destination) cil managed" />

<MemberSignature Language="DocId" Value="M:System.IO.Compression.ZipFile.CreateFromDirectory(System.String,System.IO.Stream)" />

<MemberSignature Language="VB.NET" Value="Public Shared Sub CreateFromDirectory (sourceDirectoryName As String, destination As Stream)" />

<MemberSignature Language="F#" Value="static member CreateFromDirectory : string * System.IO.Stream -&gt; unit" Usage="System.IO.Compression.ZipFile.CreateFromDirectory (sourceDirectoryName, destination)" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; static void CreateFromDirectory(System::String ^ sourceDirectoryName, System::IO::Stream ^ destination);" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.IO.Compression.ZipFile</AssemblyName>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Void</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="sourceDirectoryName" Type="System.String" Index="0" FrameworkAlternate="net-8.0;net-9.0;net-10.0;net-11.0" />

<Parameter Name="destination" Type="System.IO.Stream" Index="1" FrameworkAlternate="net-8.0;net-9.0;net-10.0;net-11.0" />

</Parameters>

<Docs>

<param name="sourceDirectoryName">The path to the directory to be archived, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>

<param name="destination">The stream where the zip archive is to be stored.</param>

<summary>Creates a zip archive in the specified stream that contains the files and directories from the specified directory.</summary>

<remarks>The directory structure from the file system is preserved in the archive. If the directory is empty, an empty archive is created.

This method overload does not include the base directory in the archive and does not allow you to specify a compression level.

If you want to include the base directory or specify a compression level, call the <see cref="M:System.IO.Compression.ZipFile.CreateFromDirectory(System.String,System.IO.Stream,System.IO.Compression.CompressionLevel,System.Boolean)" /> method overload.

If a file in the directory cannot be added to the archive, the archive is left incomplete and invalid, and the method throws an <see cref="T:System.IO.IOException" /> exception.</remarks>

<exception cref="T:System.ArgumentException">

<paramref name="sourceDirectoryName" /> is <see cref="F:System.String.Empty" />, contains only white space, or contains at least one invalid character.

-or-

The <paramref name="destination" /> stream does not support writing.</exception>

<exception cref="T:System.ArgumentNullException">

<paramref name="sourceDirectoryName" /> or <paramref name="destination" /> is <see langword="null" />.</exception>

<exception cref="T:System.IO.PathTooLongException">In <paramref name="sourceDirectoryName" />, the specified path, file name, or both exceed the system-defined maximum length.</exception>

<exception cref="T:System.IO.DirectoryNotFoundException">

<paramref name="sourceDirectoryName" /> is invalid or does not exist (for example, it is on an unmapped drive).</exception>

<exception cref="T:System.IO.IOException">A file in the specified directory could not be opened.

-or-

An I/O error occurred while opening a file to be archived.</exception>

<exception cref="T:System.NotSupportedException">

<paramref name="sourceDirectoryName" /> contains an invalid format.</exception>

</Docs>

</Member>

<Member MemberName="CreateFromDirectory">

<MemberSignature Language="C#" Value="public static void CreateFromDirectory (string sourceDirectoryName, string destinationArchiveFileName);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig void CreateFromDirectory(string sourceDirectoryName, string destinationArchiveFileName) cil managed" />

<MemberSignature Language="DocId" Value="M:System.IO.Compression.ZipFile.CreateFromDirectory(System.String,System.String)" />

<MemberSignature Language="VB.NET" Value="Public Shared Sub CreateFromDirectory (sourceDirectoryName As String, destinationArchiveFileName As String)" />

<MemberSignature Language="F#" Value="static member CreateFromDirectory : string * string -&gt; unit" Usage="System.IO.Compression.ZipFile.CreateFromDirectory (sourceDirectoryName, destinationArchiveFileName)" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; static void CreateFromDirectory(System::String ^ sourceDirectoryName, System::String ^ destinationArchiveFileName);" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.IO.Compression.ZipFile</AssemblyName>

<AssemblyVersion>4.0.0.0</AssemblyVersion>

<AssemblyVersion>4.0.1.0</AssemblyVersion>

<AssemblyVersion>4.0.3.0</AssemblyVersion>

<AssemblyVersion>4.0.4.0</AssemblyVersion>

<AssemblyVersion>4.0.5.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<AssemblyInfo>

<AssemblyName>System.IO.Compression.FileSystem</AssemblyName>

<AssemblyVersion>2.0.5.0</AssemblyVersion>

<AssemblyVersion>4.0.0.0</AssemblyVersion>

</AssemblyInfo>

<AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

<AssemblyVersion>2.0.0.0</AssemblyVersion>

<AssemblyVersion>2.1.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Void</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="sourceDirectoryName" Type="System.String" />

<Parameter Name="destinationArchiveFileName" Type="System.String" />

</Parameters>

<Docs>

<param name="sourceDirectoryName">The path to the directory to be archived, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>

<param name="destinationArchiveFileName">The path of the archive to be created, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>

<summary>Creates a zip archive that contains the files and directories from the specified directory.</summary>

<remarks>

<format type="text/markdown"><![CDATA[

]]></format>

</remarks>

<exception cref="T:System.ArgumentException">

<paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" /> is <see cref="F:System.String.Empty" />, contains only white space, or contains at least one invalid character.</exception>

<exception cref="T:System.ArgumentNullException">

<paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" /> is <see langword="null" />.</exception>

<exception cref="T:System.IO.PathTooLongException">In <paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" />, the specified path, file name, or both exceed the system-defined maximum length.</exception>

<exception cref="T:System.IO.DirectoryNotFoundException">

<paramref name="sourceDirectoryName" /> is invalid or does not exist (for example, it is on an unmapped drive).</exception>

<exception cref="T:System.IO.IOException">

<paramref name="destinationArchiveFileName" /> already exists.

-or-

A file in the specified directory could not be opened.

-or-

An I/O error occurred while opening a file to be archived.</exception>

<exception cref="T:System.UnauthorizedAccessException">

<paramref name="destinationArchiveFileName" /> specifies a directory.

-or-

The caller does not have the required permission to access the directory specified in <paramref name="sourceDirectoryName" /> or the file specified in <paramref name="destinationArchiveFileName" />.</exception>

<exception cref="T:System.NotSupportedException">

<paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" /> contains an invalid format.

-or-

The zip archive does not support writing.</exception>

</Docs>

</Member>

<Member MemberName="CreateFromDirectory">

<MemberSignature Language="C#" Value="public static void CreateFromDirectory (string sourceDirectoryName, System.IO.Stream destination, System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig void CreateFromDirectory(string sourceDirectoryName, class System.IO.Stream destination, valuetype System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory) cil managed" />

<MemberSignature Language="DocId" Value="M:System.IO.Compression.ZipFile.CreateFromDirectory(System.String,System.IO.Stream,System.IO.Compression.CompressionLevel,System.Boolean)" />

<MemberSignature Language="VB.NET" Value="Public Shared Sub CreateFromDirectory (sourceDirectoryName As String, destination As Stream, compressionLevel As CompressionLevel, includeBaseDirectory As Boolean)" />

<MemberSignature Language="F#" Value="static member CreateFromDirectory : string * System.IO.Stream * System.IO.Compression.CompressionLevel * bool -&gt; unit" Usage="System.IO.Compression.ZipFile.CreateFromDirectory (sourceDirectoryName, destination, compressionLevel, includeBaseDirectory)" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; static void CreateFromDirectory(System::String ^ sourceDirectoryName, System::IO::Stream ^ destination, System::IO::Compression::CompressionLevel compressionLevel, bool includeBaseDirectory);" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.IO.Compression.ZipFile</AssemblyName>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Void</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="sourceDirectoryName" Type="System.String" Index="0" FrameworkAlternate="net-8.0;net-9.0;net-10.0;net-11.0" />

<Parameter Name="destination" Type="System.IO.Stream" Index="1" FrameworkAlternate="net-8.0;net-9.0;net-10.0;net-11.0" />

<Parameter Name="compressionLevel" Type="System.IO.Compression.CompressionLevel" Index="2" FrameworkAlternate="net-8.0;net-9.0;net-10.0;net-11.0" />

<Parameter Name="includeBaseDirectory" Type="System.Boolean" Index="3" FrameworkAlternate="net-8.0;net-9.0;net-10.0;net-11.0" />

</Parameters>

<Docs>

<param name="sourceDirectoryName">The path to the directory to be archived, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>

<param name="destination">The stream where the zip archive is to be stored.</param>

<param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param>

<param name="includeBaseDirectory">

<see langword="true" /> to include the directory name from <paramref name="sourceDirectoryName" /> at the root of the archive; <see langword="false" /> to include only the contents of the directory.</param>

<summary>Creates a zip archive in the specified stream that contains the files and directories from the specified directory, uses the specified compression level, and optionally includes the base directory.</summary>

<remarks>The directory structure from the file system is preserved in the archive. If the directory is empty, an empty archive is created.

Use this method overload to specify the compression level and whether to include the base directory in the archive.

If a file in the directory cannot be added to the archive, the archive is left incomplete and invalid, and the method throws an <see cref="T:System.IO.IOException" /> exception.</remarks>

<exception cref="T:System.ArgumentException">

<paramref name="sourceDirectoryName" /> is <see cref="F:System.String.Empty" />, contains only white space, or contains at least one invalid character.

-or-

The <paramref name="destination" /> stream does not support writing.</exception>

<exception cref="T:System.ArgumentNullException">

<paramref name="sourceDirectoryName" /> or <paramref name="destination" /> is <see langword="null" />.</exception>

<exception cref="T:System.IO.PathTooLongException">In <paramref name="sourceDirectoryName" />, the specified path, file name, or both exceed the system-defined maximum length.</exception>

<exception cref="T:System.IO.DirectoryNotFoundException">

<paramref name="sourceDirectoryName" /> is invalid or does not exist (for example, it is on an unmapped drive).</exception>

<exception cref="T:System.IO.IOException">A file in the specified directory could not be opened.

-or-

An I/O error occurred while opening a file to be archived.</exception>

<exception cref="T:System.NotSupportedException">

<paramref name="sourceDirectoryName" /> contains an invalid format.</exception>

<exception cref="T:System.ArgumentOutOfRangeException">

<paramref name="compressionLevel" /> is not a valid <see cref="T:System.IO.Compression.CompressionLevel" /> value.</exception>

</Docs>

</Member>

<Member MemberName="CreateFromDirectory">

<MemberSignature Language="C#" Value="public static void CreateFromDirectory (string sourceDirectoryName, string destinationArchiveFileName, System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig void CreateFromDirectory(string sourceDirectoryName, string destinationArchiveFileName, valuetype System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory) cil managed" />

<MemberSignature Language="DocId" Value="M:System.IO.Compression.ZipFile.CreateFromDirectory(System.String,System.String,System.IO.Compression.CompressionLevel,System.Boolean)" />

<MemberSignature Language="VB.NET" Value="Public Shared Sub CreateFromDirectory (sourceDirectoryName As String, destinationArchiveFileName As String, compressionLevel As CompressionLevel, includeBaseDirectory As Boolean)" />

<MemberSignature Language="F#" Value="static member CreateFromDirectory : string * string * System.IO.Compression.CompressionLevel * bool -&gt; unit" Usage="System.IO.Compression.ZipFile.CreateFromDirectory (sourceDirectoryName, destinationArchiveFileName, compressionLevel, includeBaseDirectory)" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; static void CreateFromDirectory(System::String ^ sourceDirectoryName, System::String ^ destinationArchiveFileName, System::IO::Compression::CompressionLevel compressionLevel, bool includeBaseDirectory);" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.IO.Compression.ZipFile</AssemblyName>

<AssemblyVersion>4.0.0.0</AssemblyVersion>

<AssemblyVersion>4.0.1.0</AssemblyVersion>

<AssemblyVersion>4.0.3.0</AssemblyVersion>

<AssemblyVersion>4.0.4.0</AssemblyVersion>

<AssemblyVersion>4.0.5.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<AssemblyInfo>

<AssemblyName>System.IO.Compression.FileSystem</AssemblyName>

<AssemblyVersion>2.0.5.0</AssemblyVersion>

<AssemblyVersion>4.0.0.0</AssemblyVersion>

</AssemblyInfo>

<AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

<AssemblyVersion>2.0.0.0</AssemblyVersion>

<AssemblyVersion>2.1.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Void</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="sourceDirectoryName" Type="System.String" />

<Parameter Name="destinationArchiveFileName" Type="System.String" />

<Parameter Name="compressionLevel" Type="System.IO.Compression.CompressionLevel" />

<Parameter Name="includeBaseDirectory" Type="System.Boolean" />

</Parameters>

<Docs>

<param name="sourceDirectoryName">The path to the directory to be archived, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>

<param name="destinationArchiveFileName">The path of the archive to be created, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>

<param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param>

<param name="includeBaseDirectory">

<see langword="true" /> to include the directory name from <paramref name="sourceDirectoryName" /> at the root of the archive; <see langword="false" /> to include only the contents of the directory.</param>

<summary>Creates a zip archive that contains the files and directories from the specified directory, uses the specified compression level, and optionally includes the base directory.</summary>

<remarks>

<format type="text/markdown"><![CDATA[

]]></format>

</remarks>

<exception cref="T:System.ArgumentException">

<paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" /> is <see cref="F:System.String.Empty" />, contains only white space, or contains at least one invalid character.</exception>

<exception cref="T:System.ArgumentNullException">

<paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" /> is <see langword="null" />.</exception>

<exception cref="T:System.IO.PathTooLongException">In <paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" />, the specified path, file name, or both exceed the system-defined maximum length.</exception>

<exception cref="T:System.IO.DirectoryNotFoundException">

<paramref name="sourceDirectoryName" /> is invalid or does not exist (for example, it is on an unmapped drive).</exception>

<exception cref="T:System.IO.IOException">

<paramref name="destinationArchiveFileName" /> already exists.

-or-

A file in the specified directory could not be opened.

-or-

An I/O error occurred while opening a file to be archived.</exception>

<exception cref="T:System.UnauthorizedAccessException">

<paramref name="destinationArchiveFileName" /> specifies a directory.

-or-

The caller does not have the required permission to access the directory specified in <paramref name="sourceDirectoryName" /> or the file specified in <paramref name="destinationArchiveFileName" />.</exception>

<exception cref="T:System.NotSupportedException">

<paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" /> contains an invalid format.

-or-

The zip archive does not support writing.</exception>

</Docs>

</Member>

<Member MemberName="CreateFromDirectory">

<MemberSignature Language="C#" Value="public static void CreateFromDirectory (string sourceDirectoryName, System.IO.Stream destination, System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, System.Text.Encoding? entryNameEncoding);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig void CreateFromDirectory(string sourceDirectoryName, class System.IO.Stream destination, valuetype System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, class System.Text.Encoding entryNameEncoding) cil managed" />

<MemberSignature Language="DocId" Value="M:System.IO.Compression.ZipFile.CreateFromDirectory(System.String,System.IO.Stream,System.IO.Compression.CompressionLevel,System.Boolean,System.Text.Encoding)" />

<MemberSignature Language="VB.NET" Value="Public Shared Sub CreateFromDirectory (sourceDirectoryName As String, destination As Stream, compressionLevel As CompressionLevel, includeBaseDirectory As Boolean, entryNameEncoding As Encoding)" />

<MemberSignature Language="F#" Value="static member CreateFromDirectory : string * System.IO.Stream * System.IO.Compression.CompressionLevel * bool * System.Text.Encoding -&gt; unit" Usage="System.IO.Compression.ZipFile.CreateFromDirectory (sourceDirectoryName, destination, compressionLevel, includeBaseDirectory, entryNameEncoding)" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; static void CreateFromDirectory(System::String ^ sourceDirectoryName, System::IO::Stream ^ destination, System::IO::Compression::CompressionLevel compressionLevel, bool includeBaseDirectory, System::Text::Encoding ^ entryNameEncoding);" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.IO.Compression.ZipFile</AssemblyName>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Void</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="sourceDirectoryName" Type="System.String" Index="0" FrameworkAlternate="net-8.0;net-9.0;net-10.0;net-11.0" />

<Parameter Name="destination" Type="System.IO.Stream" Index="1" FrameworkAlternate="net-8.0;net-9.0;net-10.0;net-11.0" />

<Parameter Name="compressionLevel" Type="System.IO.Compression.CompressionLevel" Index="2" FrameworkAlternate="net-8.0;net-9.0;net-10.0;net-11.0" />

<Parameter Name="includeBaseDirectory" Type="System.Boolean" Index="3" FrameworkAlternate="net-8.0;net-9.0;net-10.0;net-11.0" />

<Parameter Name="entryNameEncoding" Type="System.Text.Encoding" Index="4" FrameworkAlternate="net-8.0;net-9.0;net-10.0;net-11.0">

<Attributes>

<Attribute>

<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>

<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(2)&gt;]</AttributeName>

</Attribute>

</Attributes>

</Parameter>

</Parameters>

<Docs>

<param name="sourceDirectoryName">The path to the directory to be archived, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>

<param name="destination">The stream where the zip archive is to be stored.</param>

<param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param>

<param name="includeBaseDirectory">

<see langword="true" /> to include the directory name from <paramref name="sourceDirectoryName" /> at the root of the archive; <see langword="false" /> to include only the contents of the directory.</param>

<param name="entryNameEncoding">The encoding to use when reading or writing entry names and comments 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 or comments.</param>

<summary>Creates a zip archive in the specified stream that contains the files and directories from the specified directory, uses the specified compression level and character encoding for entry names and comments, and optionally includes the base directory.</summary>

<remarks>The directory structure from the file system is preserved in the archive. If the directory is empty, an empty archive is created.

Use this method overload to specify the compression level and character encoding, and whether to include the base directory in the archive.

If a file in the directory cannot be added to the archive, the archive is left incomplete and invalid, and the method throws an <see cref="T:System.IO.IOException" /> exception.</remarks>

<exception cref="T:System.ArgumentException">

<paramref name="sourceDirectoryName" /> is <see cref="F:System.String.Empty" />, contains only white space, or contains at least one invalid character.

-or-

The <paramref name="destination" /> stream does not support writing.</exception>

<exception cref="T:System.ArgumentNullException">

<paramref name="sourceDirectoryName" /> or <paramref name="destination" /> is <see langword="null" />.</exception>

<exception cref="T:System.IO.PathTooLongException">In <paramref name="sourceDirectoryName" />, the specified path, file name, or both exceed the system-defined maximum length.</exception>

<exception cref="T:System.IO.DirectoryNotFoundException">

<paramref name="sourceDirectoryName" /> is invalid or does not exist (for example, it is on an unmapped drive).</exception>

<exception cref="T:System.IO.IOException">A file in the specified directory could not be opened.

-or-

An I/O error occurred while opening a file to be archived.</exception>

<exception cref="T:System.NotSupportedException">

<paramref name="sourceDirectoryName" /> contains an invalid format.</exception>

<exception cref="T:System.ArgumentOutOfRangeException">

<paramref name="compressionLevel" /> is not a valid <see cref="T:System.IO.Compression.CompressionLevel" /> value.</exception>

</Docs>

</Member>

<Member MemberName="CreateFromDirectory">

<MemberSignature Language="C#" Value="public static void CreateFromDirectory (string sourceDirectoryName, string destinationArchiveFileName, System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, System.Text.Encoding entryNameEncoding);" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-1.3;netstandard-1.4;netstandard-1.6;netstandard-2.0;netstandard-2.1" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig void CreateFromDirectory(string sourceDirectoryName, string destinationArchiveFileName, valuetype System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, class System.Text.Encoding entryNameEncoding) cil managed" />

<MemberSignature Language="DocId" Value="M:System.IO.Compression.ZipFile.CreateFromDirectory(System.String,System.String,System.IO.Compression.CompressionLevel,System.Boolean,System.Text.Encoding)" />

<MemberSignature Language="VB.NET" Value="Public Shared Sub CreateFromDirectory (sourceDirectoryName As String, destinationArchiveFileName As String, compressionLevel As CompressionLevel, includeBaseDirectory As Boolean, entryNameEncoding As Encoding)" />

<MemberSignature Language="F#" Value="static member CreateFromDirectory : string * string * System.IO.Compression.CompressionLevel * bool * System.Text.Encoding -&gt; unit" Usage="System.IO.Compression.ZipFile.CreateFromDirectory (sourceDirectoryName, destinationArchiveFileName, compressionLevel, includeBaseDirectory, entryNameEncoding)" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; static void CreateFromDirectory(System::String ^ sourceDirectoryName, System::String ^ destinationArchiveFileName, System::IO::Compression::CompressionLevel compressionLevel, bool includeBaseDirectory, System::Text::Encoding ^ entryNameEncoding);" />

<MemberSignature Language="C#" Value="public static void CreateFromDirectory (string sourceDirectoryName, string destinationArchiveFileName, System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, System.Text.Encoding? entryNameEncoding);" FrameworkAlternate="net-10.0;net-11.0;net-5.0;net-6.0;net-7.0;net-8.0;net-9.0" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.IO.Compression.ZipFile</AssemblyName>

<AssemblyVersion>4.0.0.0</AssemblyVersion>

<AssemblyVersion>4.0.1.0</AssemblyVersion>

<AssemblyVersion>4.0.3.0</AssemblyVersion>

<AssemblyVersion>4.0.4.0</AssemblyVersion>

<AssemblyVersion>4.0.5.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<AssemblyInfo>

<AssemblyName>System.IO.Compression.FileSystem</AssemblyName>

<AssemblyVersion>2.0.5.0</AssemblyVersion>

<AssemblyVersion>4.0.0.0</AssemblyVersion>

</AssemblyInfo>

<AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

<AssemblyVersion>2.0.0.0</AssemblyVersion>

<AssemblyVersion>2.1.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Void</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="sourceDirectoryName" Type="System.String" />

<Parameter Name="destinationArchiveFileName" Type="System.String" />

<Parameter Name="compressionLevel" Type="System.IO.Compression.CompressionLevel" />

<Parameter Name="includeBaseDirectory" Type="System.Boolean" />

<Parameter Name="entryNameEncoding" Type="System.Text.Encoding">

<Attributes>

<Attribute FrameworkAlternate="net-10.0;net-11.0;net-8.0;net-9.0">

<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>

<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(2)&gt;]</AttributeName>

</Attribute>

</Attributes>

</Parameter>

</Parameters>

<Docs>

<param name="sourceDirectoryName">The path to the directory to be archived, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>

<param name="destinationArchiveFileName">The path of the archive to be created, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>

<param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param>

<param name="includeBaseDirectory">

<see langword="true" /> to include the directory name from <paramref name="sourceDirectoryName" /> at the root of the archive; <see langword="false" /> to include only the contents of the directory.</param>

<param name="entryNameEncoding">The encoding to use when reading or writing entry names and comments 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 or comments.</param>

<summary>Creates a zip archive that contains the files and directories from the specified directory, uses the specified compression level and character encoding for entry names and comments, and optionally includes the base directory.</summary>

<remarks>

<format type="text/markdown"><![CDATA[

]]></format>

</remarks>

<exception cref="T:System.ArgumentException">

<paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" /> is <see cref="F:System.String.Empty" />, contains only white space, or contains at least one invalid character.

-or-

<paramref name="entryNameEncoding" /> is set to a Unicode encoding other than UTF-8.</exception>

<exception cref="T:System.ArgumentNullException">

<paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" /> is <see langword="null" />.</exception>

<exception cref="T:System.IO.PathTooLongException">In <paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" />, the specified path, file name, or both exceed the system-defined maximum length.</exception>

<exception cref="T:System.IO.DirectoryNotFoundException">

<paramref name="sourceDirectoryName" /> is invalid or does not exist (for example, it is on an unmapped drive).</exception>

<exception cref="T:System.IO.IOException">

<paramref name="destinationArchiveFileName" /> already exists.

-or-

A file in the specified directory could not be opened.

-or-

An I/O error occurred while opening a file to be archived.</exception>

<exception cref="T:System.UnauthorizedAccessException">

<paramref name="destinationArchiveFileName" /> specifies a directory.

-or-

The caller does not have the required permission to access the directory specified in <paramref name="sourceDirectoryName" /> or the file specified in <paramref name="destinationArchiveFileName" />.</exception>

<exception cref="T:System.NotSupportedException">

<paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" /> contains an invalid format.

-or-

The zip archive does not support writing.</exception>

</Docs>

</Member>

<Member MemberName="CreateFromDirectoryAsync">

<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task CreateFromDirectoryAsync (string sourceDirectoryName, System.IO.Stream destination, System.Threading.CancellationToken cancellationToken = default);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, class System.IO.Stream destination, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />

<MemberSignature Language="DocId" Value="M:System.IO.Compression.ZipFile.CreateFromDirectoryAsync(System.String,System.IO.Stream,System.Threading.CancellationToken)" />

<MemberSignature Language="VB.NET" Value="Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destination As Stream, Optional cancellationToken As CancellationToken = Nothing) As Task" />

<MemberSignature Language="F#" Value="static member CreateFromDirectoryAsync : string * System.IO.Stream * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task" Usage="System.IO.Compression.ZipFile.CreateFromDirectoryAsync (sourceDirectoryName, destination, cancellationToken)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.IO.Compression.ZipFile</AssemblyName>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Threading.Tasks.Task</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="sourceDirectoryName" Type="System.String" Index="0" FrameworkAlternate="net-10.0;net-11.0" />

<Parameter Name="destination" Type="System.IO.Stream" Index="1" FrameworkAlternate="net-10.0;net-11.0" />

<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="net-10.0;net-11.0" />

</Parameters>

<Docs>

<param name="sourceDirectoryName">The path to the directory to be archived, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>

<param name="destination">The stream where the zip archive is to be stored.</param>

<param name="cancellationToken">The cancellation token to monitor for cancellation requests.</param>

<summary>Asynchronously creates a zip archive in the specified stream that contains the files and directories from the specified directory.</summary>

<returns>To be added.</returns>

<remarks>

<para>The directory structure from the file system is preserved in the archive. If the directory is empty, an empty archive is created.</para>

<para>This method overload does not include the base directory in the archive and does not allow you to specify a compression level.</para>

<para>If you want to include the base directory or specify a compression level, call the <see cref="M:System.IO.Compression.ZipFile.CreateFromDirectory(System.String,System.IO.Stream,System.IO.Compression.CompressionLevel,System.Boolean)" /> method overload.</para>

<para>If a file in the directory cannot be added to the archive, the archive is left incomplete and invalid, and the method throws an <see cref="T:System.IO.IOException" /> exception.</para>

</remarks>

<exception cref="T:System.ArgumentException">

<para>

<paramref name="sourceDirectoryName" /> is <see cref="F:System.String.Empty" />, contains only white space, or contains at least one invalid character.</para>

<para>-or-</para>

<para>The <paramref name="destination" /> stream does not support writing.</para>

</exception>

<exception cref="T:System.ArgumentNullException">

<paramref name="sourceDirectoryName" /> or <paramref name="destination" /> is <see langword="null" />.</exception>

<exception cref="T:System.IO.PathTooLongException">In <paramref name="sourceDirectoryName" />, the specified path, file name, or both exceed the system-defined maximum length.</exception>

<exception cref="T:System.IO.DirectoryNotFoundException">

<paramref name="sourceDirectoryName" /> is invalid or does not exist (for example, it is on an unmapped drive).</exception>

<exception cref="T:System.IO.IOException">

<para>A file in the specified directory could not be opened.</para>

<para>-or-</para>

<para>An I/O error occurred while opening a file to be archived.</para>

</exception>

<exception cref="T:System.NotSupportedException">

<paramref name="sourceDirectoryName" /> contains an invalid format.</exception>

<exception cref="T:System.OperationCanceledException">An asynchronous operation is cancelled.</exception>

</Docs>

</Member>

<Member MemberName="CreateFromDirectoryAsync">

<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task CreateFromDirectoryAsync (string sourceDirectoryName, string destinationArchiveFileName, System.Threading.CancellationToken cancellationToken = default);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, string destinationArchiveFileName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />

<MemberSignature Language="DocId" Value="M:System.IO.Compression.ZipFile.CreateFromDirectoryAsync(System.String,System.String,System.Threading.CancellationToken)" />

<MemberSignature Language="VB.NET" Value="Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destinationArchiveFileName As String, Optional cancellationToken As CancellationToken = Nothing) As Task" />

<MemberSignature Language="F#" Value="static member CreateFromDirectoryAsync : string * string * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task" Usage="System.IO.Compression.ZipFile.CreateFromDirectoryAsync (sourceDirectoryName, destinationArchiveFileName, cancellationToken)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.IO.Compression.ZipFile</AssemblyName>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Threading.Tasks.Task</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="sourceDirectoryName" Type="System.String" Index="0" FrameworkAlternate="net-10.0;net-11.0" />

<Parameter Name="destinationArchiveFileName" Type="System.String" Index="1" FrameworkAlternate="net-10.0;net-11.0" />

<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="net-10.0;net-11.0" />

</Parameters>

<Docs>

<param name="sourceDirectoryName">The path to the directory on the file system to be archived.</param>

<param name="destinationArchiveFileName">The name of the archive to be created.</param>

<param name="cancellationToken">The cancellation token to monitor for cancellation requests.</param>

<summary>

Asynchronously creates a zip archive at the path <paramref name="destinationArchiveFileName" /> that contains the files and directories from the directory specified by <paramref name="sourceDirectoryName" />.

</summary>

<returns>To be added.</returns>

<remarks>

<para>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 is 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 into the archive.</para>

<para>If an error is encountered while adding files to the archive, this method stops adding files and leaves 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.If an entry with the specified name already exists in the archive, a second entry is created that has an identical name. Since no <code>CompressionLevel</code> is specified, the default provided by the implementation of the underlying compression algorithm is used; the <code>ZipArchive</code> will not impose its own default.</para>

<para>(Currently, the underlying compression algorithm is provided by the <see cref="T:System.IO.Compression.DeflateStream" /> class.)</para>

</remarks>

<exception cref="T:System.ArgumentException">

<para>

<paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" /> is a zero-length string, contains only whitespace, or contains one or more invalid characters as defined by <code>InvalidPathChars</code>.</para>

</exception>

<exception cref="T:System.ArgumentNullException">

<paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" /> is <see langword="null" />.</exception>

<exception cref="T:System.IO.PathTooLongException">

<para>In <paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" />, the specified path, file name, or both exceed the system-defined maximum length.</para>

<para>For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.</para>

</exception>

<exception cref="T:System.IO.DirectoryNotFoundException">

<para>The path specified in <paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" /> is invalid, (for example, it is on an unmapped drive).</para>

<para>-or-</para>

<para>The directory specified by <paramref name="sourceDirectoryName" /> does not exist.</para>

</exception>

<exception cref="T:System.IO.IOException">

<para>

<paramref name="destinationArchiveFileName" /> already exists.</para>

<para>-or-</para>

<para>An I/O error occurred while opening a file to be archived.</para>

</exception>

<exception cref="T:System.UnauthorizedAccessException">

<para>

<paramref name="destinationArchiveFileName" /> specified a directory.</para>

<para>-or-</para>

<para>The caller does not have the required permission.</para>

</exception>

<exception cref="T:System.NotSupportedException">

<para>

<paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" /> is in an invalid format.</para>

</exception>

<exception cref="T:System.OperationCanceledException">An asynchronous operation is cancelled.</exception>

</Docs>

</Member>

<Member MemberName="CreateFromDirectoryAsync">

<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task CreateFromDirectoryAsync (string sourceDirectoryName, System.IO.Stream destination, System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, System.Threading.CancellationToken cancellationToken = default);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, class System.IO.Stream destination, valuetype System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />

<MemberSignature Language="DocId" Value="M:System.IO.Compression.ZipFile.CreateFromDirectoryAsync(System.String,System.IO.Stream,System.IO.Compression.CompressionLevel,System.Boolean,System.Threading.CancellationToken)" />

<MemberSignature Language="VB.NET" Value="Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destination As Stream, compressionLevel As CompressionLevel, includeBaseDirectory As Boolean, Optional cancellationToken As CancellationToken = Nothing) As Task" />

<MemberSignature Language="F#" Value="static member CreateFromDirectoryAsync : string * System.IO.Stream * System.IO.Compression.CompressionLevel * bool * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task" Usage="System.IO.Compression.ZipFile.CreateFromDirectoryAsync (sourceDirectoryName, destination, compressionLevel, includeBaseDirectory, cancellationToken)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.IO.Compression.ZipFile</AssemblyName>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Threading.Tasks.Task</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="sourceDirectoryName" Type="System.String" Index="0" FrameworkAlternate="net-10.0;net-11.0" />

<Parameter Name="destination" Type="System.IO.Stream" Index="1" FrameworkAlternate="net-10.0;net-11.0" />

<Parameter Name="compressionLevel" Type="System.IO.Compression.CompressionLevel" Index="2" FrameworkAlternate="net-10.0;net-11.0" />

<Parameter Name="includeBaseDirectory" Type="System.Boolean" Index="3" FrameworkAlternate="net-10.0;net-11.0" />

<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="4" FrameworkAlternate="net-10.0;net-11.0" />

</Parameters>

<Docs>

<param name="sourceDirectoryName">The path to the directory to be archived, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>

<param name="destination">The stream where the zip archive is to be stored.</param>

<param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param>

<param name="includeBaseDirectory">

<see langword="true" /> to include the directory name from <paramref name="sourceDirectoryName" /> at the root of the archive; <see langword="false" /> to include only the contents of the directory.</param>

<param name="cancellationToken">The token to monitor for cancellation requests.</param>

<summary>Asynchronously creates a zip archive in the specified stream that contains the files and directories from the specified directory, using the specified compression level, and optionally including the base directory.</summary>

<returns>To be added.</returns>

<remarks>

<para>The directory structure from the file system is preserved in the archive. If the directory is empty, an empty archive is created.</para>

<para>Use this method overload to specify the compression level and whether to include the base directory in the archive.</para>

<para>If a file in the directory cannot be added to the archive, the archive is left incomplete and invalid, and the method throws an <see cref="T:System.IO.IOException" /> exception.</para>

</remarks>

<exception cref="T:System.ArgumentException">

<para>

<paramref name="sourceDirectoryName" /> is <see cref="F:System.String.Empty" />, contains only white space, or contains at least one invalid character.</para>

<para>-or-</para>

<para>The <paramref name="destination" /> stream does not support writing.</para>

</exception>

<exception cref="T:System.ArgumentNullException">

<paramref name="sourceDirectoryName" /> or <paramref name="destination" /> is <see langword="null" />.</exception>

<exception cref="T:System.IO.PathTooLongException">In <paramref name="sourceDirectoryName" />, the specified path, file name, or both exceed the system-defined maximum length.</exception>

<exception cref="T:System.IO.DirectoryNotFoundException">

<paramref name="sourceDirectoryName" /> is invalid or does not exist (for example, it is on an unmapped drive).</exception>

<exception cref="T:System.IO.IOException">

<para>A file in the specified directory could not be opened.</para>

<para>-or-</para>

<para>An I/O error occurred while opening a file to be archived.</para>

</exception>

<exception cref="T:System.NotSupportedException">

<paramref name="sourceDirectoryName" /> contains an invalid format.</exception>

<exception cref="T:System.ArgumentOutOfRangeException">

<paramref name="compressionLevel" /> is not a valid <see cref="T:System.IO.Compression.CompressionLevel" /> value.</exception>

<exception cref="T:System.OperationCanceledException">An asynchronous operation is cancelled.</exception>

</Docs>

</Member>

<Member MemberName="CreateFromDirectoryAsync">

<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task CreateFromDirectoryAsync (string sourceDirectoryName, string destinationArchiveFileName, System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, System.Threading.CancellationToken cancellationToken = default);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, string destinationArchiveFileName, valuetype System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />

<MemberSignature Language="DocId" Value="M:System.IO.Compression.ZipFile.CreateFromDirectoryAsync(System.String,System.String,System.IO.Compression.CompressionLevel,System.Boolean,System.Threading.CancellationToken)" />

<MemberSignature Language="VB.NET" Value="Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destinationArchiveFileName As String, compressionLevel As CompressionLevel, includeBaseDirectory As Boolean, Optional cancellationToken As CancellationToken = Nothing) As Task" />

<MemberSignature Language="F#" Value="static member CreateFromDirectoryAsync : string * string * System.IO.Compression.CompressionLevel * bool * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task" Usage="System.IO.Compression.ZipFile.CreateFromDirectoryAsync (sourceDirectoryName, destinationArchiveFileName, compressionLevel, includeBaseDirectory, cancellationToken)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.IO.Compression.ZipFile</AssemblyName>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Threading.Tasks.Task</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="sourceDirectoryName" Type="System.String" Index="0" FrameworkAlternate="net-10.0;net-11.0" />

<Parameter Name="destinationArchiveFileName" Type="System.String" Index="1" FrameworkAlternate="net-10.0;net-11.0" />

<Parameter Name="compressionLevel" Type="System.IO.Compression.CompressionLevel" Index="2" FrameworkAlternate="net-10.0;net-11.0" />

<Parameter Name="includeBaseDirectory" Type="System.Boolean" Index="3" FrameworkAlternate="net-10.0;net-11.0" />

<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="4" FrameworkAlternate="net-10.0;net-11.0" />

</Parameters>

<Docs>

<param name="sourceDirectoryName">The path to the directory on the file system to be archived.</param>

<param name="destinationArchiveFileName">The name of the archive to be created.</param>

<param name="compressionLevel">One of the enumeration values that specifies the level of the compression (speed/memory vs. compressed size trade-off).</param>

<param name="includeBaseDirectory">

<see langword="true" /> to indicate that a directory named <paramref name="sourceDirectoryName" /> should be included at the root of the archive. <see langword="false" /> to indicate that the files and directories in <paramref name="sourceDirectoryName" /> should be included directly in the archive.

</param>

<param name="cancellationToken">The cancellation token to monitor for cancellation requests.</param>

<summary>

Asynchronously creates a zip archive at the path <paramref name="destinationArchiveFileName" /> that contains the files and directories in the directory specified by <paramref name="sourceDirectoryName" />.

</summary>

<returns>To be added.</returns>

<remarks>

<para>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.</para>

<para>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.</para>

<para>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.If an entry with the specified name already exists in the archive, a second entry will be created that has an identical name. Since no <code>CompressionLevel</code> is specified, the default provided by the implementation of the underlying compression algorithm will be used; the <code>ZipArchive</code> will not impose its own default.</para>

<para>(Currently, the underlying compression algorithm is provided by the <see cref="T:System.IO.Compression.DeflateStream" /> class.)</para>

</remarks>

<exception cref="T:System.ArgumentException">

<para>

<paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" /> is a zero-length string, contains only whitespace, or contains one or more invalid characters as defined by <code>InvalidPathChars</code>.</para>

</exception>

<exception cref="T:System.ArgumentNullException">

<paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" /> is <see langword="null" />.</exception>

<exception cref="T:System.IO.PathTooLongException">

<para>In <paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" />, the specified path, file name, or both exceed the system-defined maximum length.</para>

<para>For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.</para>

</exception>

<exception cref="T:System.IO.DirectoryNotFoundException">

<para>The path specified in <paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" /> is invalid, (for example, it is on an unmapped drive).</para>

<para>-or-</para>

<para>The directory specified by <paramref name="sourceDirectoryName" /> does not exist.</para>

</exception>

<exception cref="T:System.IO.IOException">

<para>

<paramref name="destinationArchiveFileName" /> already exists.</para>

<para>-or-</para>

<para>An I/O error occurred while opening a file to be archived.</para>

</exception>

<exception cref="T:System.UnauthorizedAccessException">

<para>

<paramref name="destinationArchiveFileName" /> specified a directory.</para>

<para>-or-</para>

<para>The caller does not have the required permission.</para>

</exception>

<exception cref="T:System.NotSupportedException">

<para>

<paramref name="sourceDirectoryName" /> or <paramref name="destinationArchiveFileName" /> is in an invalid format.</para>

</exception>

<exception cref="T:System.OperationCanceledException">An asynchronous operation is cancelled.</exception>

</Docs>

</Member>

<Member MemberName="CreateFromDirectoryAsync">

<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task CreateFromDirectoryAsync (string sourceDirectoryName, System.IO.Stream destination, System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, System.Text.Encoding? entryNameEncoding, System.Threading.CancellationToken cancellationToken = default);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, class System.IO.Stream destination, valuetype System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, class System.Text.Encoding entryNameEncoding, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />

<MemberSignature Language="DocId" Value="M:System.IO.Compression.ZipFile.CreateFromDirectoryAsync(System.String,System.IO.Stream,System.IO.Compression.CompressionLevel,System.Boolean,System.Text.Encoding,System.Threading.CancellationToken)" />

<MemberSignature Language="VB.NET" Value="Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destination As Stream, compressionLevel As CompressionLevel, includeBaseDirectory As Boolean, entryNameEncoding As Encoding, Optional cancellationToken As CancellationToken = Nothing) As Task" />

<MemberSignature Language="F#" Value="static member CreateFromDirectoryAsync : string * System.IO.Stream * System.IO.Compression.CompressionLevel * bool * System.Text.Encoding * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task" Usage="System.IO.Compression.ZipFile.CreateFromDirectoryAsync (sourceDirectoryName, destination, compressionLevel, includeBaseDirectory, entryNameEncoding, cancellationToken)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.IO.Compression.ZipFile</AssemblyName>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Threading.Tasks.Task</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="sourceDirectoryName" Type="System.String" Index="0" FrameworkAlternate="net-10.0;net-11.0" />

<Parameter Name="destination" Type="System.IO.Stream" Index="1" FrameworkAlternate="net-10.0;net-11.0" />

<Parameter Name="compressionLevel" Type="System.IO.Compression.CompressionLevel" Index="2" FrameworkAlternate="net-10.0;net-11.0" />

<Parameter Name="includeBaseDirectory" Type="System.Boolean" Index="3" FrameworkAlternate="net-10.0;net-11.0" />

<Parameter Name="entryNameEncoding" Type="System.Text.Encoding" Index="4" FrameworkAlternate="net-10.0;net-11.0">

<Attributes>

<Attribute>

<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>

<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(2)&gt;]</AttributeName>

</Attribute>

</Attributes>

</Parameter>

<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="5" FrameworkAlternate="net-10.0;net-11.0" />

</Parameters>

<Docs>

<param name="sourceDirectoryName">The path to the directory to be archived, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>

<param name="destination">The stream where the zip archive is to be stored.</param>

<param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param>

<param name="includeBaseDirectory">

<see langword="true" /> to include the directory name from <paramref name="sourceDirectoryName" /> at the root of the archive; <see langword="false" /> to include only the contents of the directory.</param>

<param name="entryNameEncoding">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 or comments.</param>

<param name="cancellationToken">The cancellation token to monitor for cancellation requests.</param>

<summary>Asynchronously creates a zip archive in the specified stream that contains the files and directories from the specified directory, using the specified compression level and character encoding for entry names, and optionally including the base directory.</summary>

<returns>To be added.</returns>

<remarks>

<para>The directory structure from the file system is preserved in the archive. If the directory is empty, an empty archive is created.</para>

<para>Use this method overload to specify the compression level and character encoding, and whether to include the base directory in the archive.</para>

<para>If a file in the directory cannot be added to the archive, the archive is left incomplete and invalid, and the method throws an <see cref="T:System.IO.IOException" /> exception.</para>

</remarks>

<exception cref="T:System.ArgumentException">

<para>

<paramref name="sourceDirectoryName" /> is <see cref="F:System.String.Empty" />, contains only white space, or contains at least one invalid character.</para>

<para>-or-</para>

<para>The <paramref name="destination" /> stream does not support writing.</para>

</exception>

<exception cref="T:System.ArgumentNullException">

<paramref name="sourceDirectoryName" /> or <paramref name="destination" /> is <see langword="null" />.</exception>

<exception cref="T:System.IO.PathTooLongException">In <paramref name="sourceDirectoryName" />, the specified path, file name, or both exceed the system-defined maximum length.</exception>

<exception cref="T:System.IO.DirectoryNotFoundException">

<paramref name="sourceDirectoryName" /> is invalid or does not exist (for example, it is on an unmapped drive).</exception>

<exception cref="T:System.IO.IOException">

<para>A file in the specified directory could not be opened.</para>

<para>-or-</para>

<para>An I/O error occurred while opening a file to be archived.</para>

</exception>

<exception cref="T:System.NotSupportedException">

<paramref name="sourceDirectoryName" /> contains an invalid format.</exception>

<exception cref="T:System.ArgumentOutOfRangeException">

<paramref name="compressionLevel" /> is not a valid <see cref="T:System.IO.Compression.CompressionLevel" /> value.</exception>

<exception cref="T:System.OperationCanceledException">An asynchronous operation is cancelled.</exception>

</Docs>

</Member>

<Member MemberName="CreateFromDirectoryAsync">

<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task CreateFromDirectoryAsync (string sourceDirectoryName, string destinationArchiveFileName, System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, System.Text.Encoding? entryNameEncoding, System.Threading.CancellationToken cancellationToken = default);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, string destinationArchiveFileName, valuetype System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, class System.Text.Encoding entryNameEncoding, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />

<MemberSignature Language="DocId" Value="M:System.IO.Compression.ZipFile.CreateFromDirectoryAsync(System.String,System.String,System.IO.Compression.CompressionLevel,System.Boolean,System.Text.Encoding,System.Threading.CancellationToken)" />

<MemberSignature Language="VB.NET" Value="Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destinationArchiveFileName As String, compressionLevel As CompressionLevel, includeBaseDirectory As Boolean, entryNameEncoding As Encoding, Optional cancellationToken As CancellationToken = Nothing) As Task" />

<MemberSignature Language="F#" Value="static member CreateFromDirectoryAsync : string * string * System.IO.Compression.CompressionLevel * bool * System.Text.Encoding * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task" Usage="System.IO.Compression.ZipFile.CreateFromDirectoryAsync (sourceDirectoryName, destinationArchiveFileName, compressionLevel, includeBaseDirectory, entryNameEncoding, cancellationToken)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.IO.Compression.ZipFile</AssemblyName>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Threading.Tasks.Task</ReturnType>