ZipFileExtensions.CreateEntryFromFile Method

Reference

Definition

Namespace:: System.IO.Compression

Assembly:: System.IO.Compression.ZipFile.dll

Assembly:: System.IO.Compression.FileSystem.dll

Assembly:: netstandard.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Archives a file by compressing it and adding it to the zip archive.

Overloads

CreateEntryFromFile(ZipArchive, String, String)	Archives a file by compressing it and adding it to the zip archive.
CreateEntryFromFile(ZipArchive, String, String, CompressionLevel)	Archives a file by compressing it using the specified compression level and adding it to the zip archive.

CreateEntryFromFile(ZipArchive, String, String)

Source:: ZipFileExtensions.ZipArchive.Create.cs

Source:: ZipFileExtensions.ZipArchive.Create.cs

Source:: ZipFileExtensions.ZipArchive.Create.cs

Archives a file by compressing it and adding it to the zip archive.

public:
[System::Runtime::CompilerServices::Extension]
 static System::IO::Compression::ZipArchiveEntry ^ CreateEntryFromFile(System::IO::Compression::ZipArchive ^ destination, System::String ^ sourceFileName, System::String ^ entryName);

public static System.IO.Compression.ZipArchiveEntry CreateEntryFromFile (this System.IO.Compression.ZipArchive destination, string sourceFileName, string entryName);

static member CreateEntryFromFile : System.IO.Compression.ZipArchive * string * string -> System.IO.Compression.ZipArchiveEntry

<Extension()>
Public Function CreateEntryFromFile (destination As ZipArchive, sourceFileName As String, entryName As String) As ZipArchiveEntry

Parameters

destination: ZipArchive

The zip archive to add the file to.

sourceFileName: String

The path to the file to be archived. You can specify either a relative or an absolute path. A relative path is interpreted as relative to the current working directory.

entryName: String

The name of the entry to create in the zip archive.

Returns

ZipArchiveEntry

A wrapper for the new entry in the zip archive.

Exceptions

ArgumentException

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

-or-

entryName is Empty.

ArgumentNullException

sourceFileName or entryName is null.

PathTooLongException

In sourceFileName, the specified path, file name, or both exceed the system-defined maximum length.

DirectoryNotFoundException

sourceFileName is invalid (for example, it is on an unmapped drive).

IOException

The file specified by sourceFileName cannot be opened, or is too large to be updated (current limit is Int32.MaxValue.

UnauthorizedAccessException

sourceFileName specifies a directory.

-or-

The caller does not have the required permission to access the file specified by sourceFileName.

FileNotFoundException

The file specified by sourceFileName is not found.

NotSupportedException

The sourceFileName parameter is in an invalid format.

-or-

The zip archive does not support writing.

ObjectDisposedException

The zip archive has been disposed.

Examples

The following example shows how to create a new entry in a zip archive from an existing file.

using System;
using System.IO;
using System.IO.Compression;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            string zipPath = @"c:\users\exampleuser\start.zip";
            string extractPath = @"c:\users\exampleuser\extract";
            string newFile = @"c:\users\exampleuser\NewFile.txt";

            using (ZipArchive archive = ZipFile.Open(zipPath, ZipArchiveMode.Update))
            {
                archive.CreateEntryFromFile(newFile, "NewEntry.txt");
                archive.ExtractToDirectory(extractPath);
            }
        }
    }
}

Imports System.IO
Imports System.IO.Compression

Module Module1

    Sub Main()
        Dim zipPath As String = "c:\users\exampleuser\end.zip"
        Dim extractPath As String = "c:\users\exampleuser\extract"
        Dim newFile As String = "c:\users\exampleuser\NewFile.txt"

        Using archive As ZipArchive = ZipFile.Open(zipPath, ZipArchiveMode.Update)
            archive.CreateEntryFromFile(newFile, "NewEntry.txt", CompressionLevel.Fastest)
            archive.ExtractToDirectory(extractPath)
        End Using
    End Sub

End Module

Remarks

The new entry in the archive contains the contents of the file specified by sourceFileName. If an entry with the specified name (entryName) already exists in the archive, a second entry is created with an identical name. The LastWriteTime property of the entry is set to the last time the file on the file system was changed.

When ZipArchiveMode.Update is present, the size limit of an entry is limited to Int32.MaxValue. This limit is because update mode uses a MemoryStream internally to allow the seeking required when updating an archive, and MemoryStream has a maximum equal to the size of an int.

Applies to

CreateEntryFromFile(ZipArchive, String, String, CompressionLevel)

Source:: ZipFileExtensions.ZipArchive.Create.cs

Source:: ZipFileExtensions.ZipArchive.Create.cs

Source:: ZipFileExtensions.ZipArchive.Create.cs

Archives a file by compressing it using the specified compression level and adding it to the zip archive.

public:
[System::Runtime::CompilerServices::Extension]
 static System::IO::Compression::ZipArchiveEntry ^ CreateEntryFromFile(System::IO::Compression::ZipArchive ^ destination, System::String ^ sourceFileName, System::String ^ entryName, System::IO::Compression::CompressionLevel compressionLevel);

public static System.IO.Compression.ZipArchiveEntry CreateEntryFromFile (this System.IO.Compression.ZipArchive destination, string sourceFileName, string entryName, System.IO.Compression.CompressionLevel compressionLevel);

static member CreateEntryFromFile : System.IO.Compression.ZipArchive * string * string * System.IO.Compression.CompressionLevel -> System.IO.Compression.ZipArchiveEntry

<Extension()>
Public Function CreateEntryFromFile (destination As ZipArchive, sourceFileName As String, entryName As String, compressionLevel As CompressionLevel) As ZipArchiveEntry

Parameters

destination: ZipArchive

The zip archive to add the file to.

sourceFileName: String

The path to the file to be archived. You can specify either a relative or an absolute path. A relative path is interpreted as relative to the current working directory.

entryName: String

The name of the entry to create in the zip archive.

compressionLevel: CompressionLevel

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

Returns

ZipArchiveEntry

A wrapper for the new entry in the zip archive.

Exceptions

ArgumentException

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

-or-

entryName is Empty.

ArgumentNullException

sourceFileName or entryName is null.

DirectoryNotFoundException

sourceFileName is invalid (for example, it is on an unmapped drive).

PathTooLongException

In sourceFileName, the specified path, file name, or both exceed the system-defined maximum length.

IOException

The file specified by sourceFileName cannot be opened, or is too large to be updated (current limit is Int32.MaxValue.

UnauthorizedAccessException

sourceFileName specifies a directory.

-or-

The caller does not have the required permission to access the file specified by sourceFileName.

FileNotFoundException

The file specified by sourceFileName is not found.

NotSupportedException

The sourceFileName parameter is in an invalid format.

-or-

The zip archive does not support writing.

ObjectDisposedException

The zip archive has been disposed.

Examples

The following example shows how to create a new entry in a zip archive from an existing file, and specify the compression level.

using System;
using System.IO;
using System.IO.Compression;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            string zipPath = @"c:\users\exampleuser\start.zip";
            string extractPath = @"c:\users\exampleuser\extract";
            string newFile = @"c:\users\exampleuser\NewFile.txt";

            using (ZipArchive archive = ZipFile.Open(zipPath, ZipArchiveMode.Update))
            {
                archive.CreateEntryFromFile(newFile, "NewEntry.txt", CompressionLevel.Fastest);
                archive.ExtractToDirectory(extractPath);
            }
        }
    }
}

Imports System.IO
Imports System.IO.Compression

Module Module1

    Sub Main()
        Dim zipPath As String = "c:\users\exampleuser\end.zip"
        Dim extractPath As String = "c:\users\exampleuser\extract"
        Dim newFile As String = "c:\users\exampleuser\NewFile.txt"

        Using archive As ZipArchive = ZipFile.Open(zipPath, ZipArchiveMode.Update)
            archive.CreateEntryFromFile(newFile, "NewEntry.txt", CompressionLevel.Fastest)
            archive.ExtractToDirectory(extractPath)
        End Using
    End Sub

End Module

Remarks

Applies to

Share via

ZipFileExtensions.CreateEntryFromFile Method

Definition

Overloads

CreateEntryFromFile(ZipArchive, String, String)

Parameters

Returns

Exceptions

Examples

Remarks

Applies to

CreateEntryFromFile(ZipArchive, String, String, CompressionLevel)

Parameters

Returns

Exceptions

Examples

Remarks

Applies to

Additional resources