ZipFileExtensions::CreateEntryFromFile Method (ZipArchive^, String^, String^, CompressionLevel)

.NET Framework (current version)

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

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

Syntax

C++

public:
[ExtensionAttribute]
static ZipArchiveEntry^ CreateEntryFromFile(
	ZipArchive^ destination,
	String^ sourceFileName,
	String^ entryName,
	CompressionLevel compressionLevel
)

Parameters

destination: Type: System.IO.Compression::ZipArchive^
The zip archive to add the file to.

sourceFileName: Type: System::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: Type: System::String^
The name of the entry to create in the zip archive.

compressionLevel: Type: System.IO.Compression::CompressionLevel
One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.

Return Value

Type: System.IO.Compression::ZipArchiveEntry^

A wrapper for the new entry in the zip archive.

Exceptions

Exception	Condition
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. For example, on Windows-based platforms, paths must not exceed 248 characters, and file names must not exceed 260 characters.
IOException	The file specified by sourceFileName cannot be opened.
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.

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.