CreateEntry

Archive.CreateEntry method (1 of 4)

Create single entry within the archive.

public ArchiveEntry CreateEntry(string name, string path, bool openImmediately = false, 
    ArchiveEntrySettings newEntrySettings = null)
ParameterTypeDescription
nameStringThe name of the entry.
pathStringThe fully qualified name of the new file, or the relative file name to be compressed.
openImmediatelyBooleanTrue if open the file immediately, otherwise open the file on archive saving.
newEntrySettingsArchiveEntrySettingsCompression and encryption settings used for added ArchiveEntry item.

Return Value

Zip entry instance.

Exceptions

exceptioncondition
ArgumentNullExceptionpath is null.
SecurityExceptionThe caller does not have the required permission to access.
ArgumentExceptionThe path is empty, contains only white spaces, or contains invalid characters.
UnauthorizedAccessExceptionAccess to file path is denied.
PathTooLongExceptionThe 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.
NotSupportedExceptionFile at path contains a colon (:) in the middle of the string.

Remarks

The entry name is solely set within name parameter. The file name provided in path parameter does not affect the entry name.

If the file is opened immediately with openImmediately parameter it becomes blocked until archive is saved.

Examples

using (FileStream zipFile = File.Open("archive.zip", FileMode.Create))
{
    using (var archive = new Archive())
    {
        archive.CreateEntry("data.bin", "file.dat");
        archive.Save(zipFile);
    }
}

See Also

Archive.CreateEntry method (2 of 4)

Create single entry within the archive.

public ArchiveEntry CreateEntry(string name, Stream source, 
    ArchiveEntrySettings newEntrySettings = null)
ParameterTypeDescription
nameStringThe name of the entry.
sourceStreamThe input stream for the entry.
newEntrySettingsArchiveEntrySettingsCompression and encryption settings used for added ArchiveEntry item.

Return Value

Zip entry instance.

Examples

using (var archive = new Archive(new ArchiveEntrySettings(null, new AesEcryptionSettings("p@s$", EncryptionMethod.AES256))))
{
    archive.CreateEntry("data.bin", new MemoryStream(new byte[] {0x00, 0xFF} ));
    archive.Save("archive.zip");
}

See Also

Archive.CreateEntry method (3 of 4)

Create single entry within the archive.

public ArchiveEntry CreateEntry(string name, FileInfo fileInfo, bool openImmediately = false, 
    ArchiveEntrySettings newEntrySettings = null)
ParameterTypeDescription
nameStringThe name of the entry.
fileInfoFileInfoThe metadata of file to be compressed.
openImmediatelyBooleanTrue if open the file immediately, otherwise open the file on archive saving.
newEntrySettingsArchiveEntrySettingsCompression and encryption settings used for added ArchiveEntry item.

Return Value

Zip entry instance.

Exceptions

exceptioncondition
UnauthorizedAccessExceptionfileInfo is read-only or is a directory.
DirectoryNotFoundExceptionThe specified path is invalid, such as being on an unmapped drive.
IOExceptionThe file is already open.

Remarks

The entry name is solely set within name parameter. The file name provided in fileInfo parameter does not affect the entry name.

If the file is opened immediately with openImmediately parameter it becomes blocked until archive is saved.

Examples

Compose archive with entries encrypted with different encryption methods and passwords each.

using (FileStream zipFile = File.Open("archive.zip", FileMode.Create))
{
    FileInfo fi1 = new FileInfo("data1.bin");
    FileInfo fi2 = new FileInfo("data2.bin");
    FileInfo fi3 = new FileInfo("data3.bin");
    using (var archive = new Archive())
    {
        archive.CreateEntry("entry1.bin", fi1, false, new ArchiveEntrySettings(new DeflateCompressionSettings(), new TraditionalEncryptionSettings("pass1")));
        archive.CreateEntry("entry2.bin", fi2, false, new ArchiveEntrySettings(new DeflateCompressionSettings(), new AesEcryptionSettings("pass2", EncryptionMethod.AES128)));
        archive.CreateEntry("entry3.bin", fi3, false, new ArchiveEntrySettings(new DeflateCompressionSettings(), new AesEcryptionSettings("pass3", EncryptionMethod.AES256)));
        archive.Save(zipFile);
    }
}

See Also

Archive.CreateEntry method (4 of 4)

Create single entry within the archive.

public ArchiveEntry CreateEntry(string name, Stream source, ArchiveEntrySettings newEntrySettings, 
    FileSystemInfo fileInfo)
ParameterTypeDescription
nameStringThe name of the entry.
sourceStreamThe input stream for the entry.
newEntrySettingsArchiveEntrySettingsCompression and encryption settings used for added ArchiveEntry item.
fileInfoFileSystemInfoThe metadata of file or folder to be compressed.

Return Value

Zip entry instance.

Exceptions

exceptioncondition
InvalidOperationExceptionBoth source and fileInfo are null or source is null and fileInfo stands for directory.

Remarks

The entry name is solely set within name parameter. The file name provided in fileInfo parameter does not affect the entry name.

fileInfo can refer to DirectoryInfo if the entry is directory.

Examples

Compose archive with encrypted entry.

using (FileStream zipFile = File.Open("archive.zip", FileMode.Create))
{
    using (var archive = new Archive())
    {
        archive.CreateEntry("entry1.bin", new MemoryStream(new byte[] {0x00, 0xFF} ), new ArchiveEntrySettings(new DeflateCompressionSettings(), new TraditionalEncryptionSettings("pass1")), new FileInfo("data1.bin")); 
        archive.Save(zipFile);
    }
}

See Also

CreateEntries DeleteEntry