Archive

Archive class

This class represents zip archive file. Use it to compose, extract, or update zip archives.

The Archive type exposes the following members:

Constructors

NameDescription
Archive(new_entry_settings)Initializes a new instance of the Archive class with optional settings for its entries.
Archive(source_stream, load_options, new_entry_settings)Initializes a new instance of the Archive class and composes entries list can be extracted from the archive.
Archive(path, load_options, new_entry_settings)Initializes a new instance of the Archive class and composes entries list can be extracted from the archive.
Archive(main_segment, segments_in_order, load_options)Initializes a new instance of the Archive class from multi-volume zip archive and composes entries list can be extracted from the archive.

Properties

NameDescription
new_entry_settingsCompression and encryption settings used for newly added ArchiveEntry items.
entriesGets entries of ArchiveEntry type constituting the archive.
file_entriesGets entries of IArchiveFileEntry type constituting the archive.

Methods

NameDescription
create_entry(name, path, open_immediately, new_entry_settings)Create single entry within the archive.
create_entry(name, source, new_entry_settings)Create single entry within the archive.
delete_entry(entry)Removes the first occurrence of a specific entry from the entries list.
delete_entry(entry_index)Removes the entry from the entries list by index.
save(output_stream, save_options)Saves archive to the stream provided.
save(destination_file_name, save_options)Saves archive to destination file provided.
create_entries(source_directory, include_root_directory)Adds to the archive all files and directories recursively in the directory given.
save_split(destination_directory, options)Saves multi-volume archive to destination directory provided.
extract_to_directory(destination_directory)Extracts all the files in the archive to the directory provided.

See Also