Aspose::Zip Namespace Reference

Classes

class  AddProgressEventArgs
 Provides information about the progress of a Add operation.
 
class  BadCrcException
 Issued when an CRC check fails upon extracting an entry from a zip archive.
 
class  BadPasswordException
 
class  BadReadException
 
class  BadStateException
 
class  CRC32
 Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the same polynomial used by Zip.
 
class  CrcCalculatorStream
 
class  DeflateStream
 A class for compressing and decompressing streams using the Deflate algorithm.
 
class  ExtractProgressEventArgs
 Provides information about the progress of the extract operation.
 
class  GZipStream
 
class  ReadProgressEventArgs
 Provides information about the progress of a Read operation.
 
class  SaveProgressEventArgs
 Provides information about the progress of a save operation.
 
class  SfxGenerationException
 Issued when errors occur saving a self-extracting archive.
 
class  ZipEntry
 
class  ZipErrorEventArgs
 Provides information about the an error that occurred while zipping.
 
class  ZipException
 Base exception type for all custom exceptions in the Zip library. It acts as a marker class.
 
class  ZipFile
 
class  ZipProgressEventArgs
 
class  ZlibBaseStream
 
class  ZlibCodec
 
class  ZlibException
 A general purpose exception class for exceptions in the Zlib library.
 
class  ZlibStream
 Represents a Zlib stream for compression or decompression.
 

Typedefs

typedef std::function< bool(int64_t, int64_t, System::String)> ReReadApprovalCallback
 
typedef std::function< bool(System::String, System::String)> WantCompressionCallback
 

Enumerations

enum  EncryptionAlgorithm { EncryptionAlgorithm::None = 0, EncryptionAlgorithm::PkzipWeak, EncryptionAlgorithm::Unsupported = 4 }
 
enum  ZipProgressEventType {
  ZipProgressEventType::Adding_Started, ZipProgressEventType::Adding_AfterAddEntry, ZipProgressEventType::Adding_Completed, ZipProgressEventType::Reading_Started,
  ZipProgressEventType::Reading_BeforeReadEntry, ZipProgressEventType::Reading_AfterReadEntry, ZipProgressEventType::Reading_Completed, ZipProgressEventType::Reading_ArchiveBytesRead,
  ZipProgressEventType::Saving_Started, ZipProgressEventType::Saving_BeforeWriteEntry, ZipProgressEventType::Saving_AfterWriteEntry, ZipProgressEventType::Saving_Completed,
  ZipProgressEventType::Saving_AfterSaveTempArchive, ZipProgressEventType::Saving_BeforeRenameTempArchive, ZipProgressEventType::Saving_AfterRenameTempArchive, ZipProgressEventType::Saving_AfterCompileSelfExtractor,
  ZipProgressEventType::Saving_EntryBytesRead, ZipProgressEventType::Extracting_BeforeExtractEntry, ZipProgressEventType::Extracting_AfterExtractEntry, ZipProgressEventType::Extracting_ExtractEntryWouldOverwrite,
  ZipProgressEventType::Extracting_EntryBytesWritten, ZipProgressEventType::Extracting_BeforeExtractAll, ZipProgressEventType::Extracting_AfterExtractAll, ZipProgressEventType::Error_Saving
}
 
enum  ExtractExistingFileAction { ExtractExistingFileAction::Throw, ExtractExistingFileAction::OverwriteSilently, ExtractExistingFileAction::DoNotOverwrite, ExtractExistingFileAction::InvokeExtractProgressEvent }
 
enum  FlushType {
  FlushType::None = 0, FlushType::Partial, FlushType::Sync, FlushType::Full,
  FlushType::Finish, FlushType::Block, FlushType::Trees
}
 
enum  Zip64Option { Zip64Option::Default = 0, Zip64Option::Never = 0, Zip64Option::AsNecessary = 1, Zip64Option::Always }
 
enum  ZipEntrySource { ZipEntrySource::None = 0, ZipEntrySource::FileSystem, ZipEntrySource::Stream, ZipEntrySource::ZipFile }
 
enum  ZipEntryTimestamp {
  ZipEntryTimestamp::None = 0, ZipEntryTimestamp::DOS = 1, ZipEntryTimestamp::Windows = 2, ZipEntryTimestamp::Unix = 4,
  ZipEntryTimestamp::InfoZip1 = 8
}
 
enum  ZipErrorAction { ZipErrorAction::Throw, ZipErrorAction::Skip, ZipErrorAction::Retry, ZipErrorAction::InvokeErrorEvent }
 
enum  CompressionLevel {
  CompressionLevel::None = 0, CompressionLevel::Level0 = 0, CompressionLevel::BestSpeed = 1, CompressionLevel::Level1 = 1,
  CompressionLevel::Level2 = 2, CompressionLevel::Level3 = 3, CompressionLevel::Level4 = 4, CompressionLevel::Level5 = 5,
  CompressionLevel::Default = 6, CompressionLevel::Level6 = 6, CompressionLevel::Level7 = 7, CompressionLevel::Level8 = 8,
  CompressionLevel::BestCompression = 9, CompressionLevel::Level9 = 9
}
 The compression level to be used when using a DeflateStream or ZlibStream with CompressionMode.Compress. More...
 
enum  CompressionStrategy {
  CompressionStrategy::Default = 0, CompressionStrategy::Filtered = 1, CompressionStrategy::HuffmanOnly = 2, CompressionStrategy::Rle = 3,
  CompressionStrategy::Fixed = 4
}
 
enum  CompressionMode { CompressionMode::Compress = 0, CompressionMode::Decompress = 1 }
 An enum to specify the direction of transcoding - whether to compress or decompress. More...
 
enum  ZlibStreamFlavor { ZlibStreamFlavor::DEFLATE = -15, ZlibStreamFlavor::ZLIB = 15, ZlibStreamFlavor::GZIP = ZLIB + 16 }
 
enum  ZlibConstants : int {
  ZlibConstants::Z_BUF_ERROR = -5, ZlibConstants::Z_DATA_ERROR = -3, ZlibConstants::Z_STREAM_ERROR = -2, ZlibConstants::Z_OK = 0,
  ZlibConstants::Z_STREAM_END = 1, ZlibConstants::Z_NEED_DICT = 2, ZlibConstants::WindowBitsMax = 15, ZlibConstants::WindowBitsDefault = WindowBitsMax,
  ZlibConstants::WorkingBufferSizeDefault = 8192, ZlibConstants::WorkingBufferSizeMin = 128
}
 

Functions

 DECLARE_ENUM_OPERATORS (Aspose::Zip::ZipEntryTimestamp)
 

Typedef Documentation

◆ ReReadApprovalCallback

typedef std::function<bool(int64_t, int64_t, System::String)> Aspose::Zip::ReReadApprovalCallback

◆ WantCompressionCallback

Enumeration Type Documentation

◆ CompressionLevel

The compression level to be used when using a DeflateStream or ZlibStream with CompressionMode.Compress.

Enumerator
None 
Level0 
BestSpeed 
Level1 
Level2 
Level3 
Level4 
Level5 
Default 
Level6 
Level7 
Level8 
BestCompression 
Level9 

◆ CompressionMode

An enum to specify the direction of transcoding - whether to compress or decompress.

Enumerator
Compress 
Decompress 

◆ CompressionStrategy

Describes options for how the compression algorithm is executed. Different strategies work better on different sorts of data. The strategy parameter can affect the compression ratio and the speed of compression but not the correctness of the compresssion.

Enumerator
Default 
Filtered 
HuffmanOnly 
Rle 
Fixed 

◆ EncryptionAlgorithm

Enumerator
None 
PkzipWeak 
Unsupported 

◆ ExtractExistingFileAction

Enumerator
Throw 
OverwriteSilently 
DoNotOverwrite 
InvokeExtractProgressEvent 

◆ FlushType

Describes how to flush the current deflate operation. The different FlushType values are useful when using a Deflate in a streaming application.

Enumerator
None 
Partial 
Sync 
Full 
Finish 
Block 
Trees 

◆ Zip64Option

Enumerator
Default 
Never 
AsNecessary 
Always 

◆ ZipEntrySource

Enumerator
None 
FileSystem 
Stream 
ZipFile 

◆ ZipEntryTimestamp

Enumerator
None 
DOS 
Windows 
Unix 
InfoZip1 

◆ ZipErrorAction

Enumerator
Throw 
Skip 
Retry 
InvokeErrorEvent 

◆ ZipProgressEventType

In an EventArgs type, indicates which sort of progress event is being reported. There are events for reading, events for saving, and events for extracting.

Enumerator
Adding_Started 
Adding_AfterAddEntry 
Adding_Completed 
Reading_Started 
Reading_BeforeReadEntry 
Reading_AfterReadEntry 
Reading_Completed 
Reading_ArchiveBytesRead 
Saving_Started 
Saving_BeforeWriteEntry 
Saving_AfterWriteEntry 
Saving_Completed 
Saving_AfterSaveTempArchive 
Saving_BeforeRenameTempArchive 
Saving_AfterRenameTempArchive 
Saving_AfterCompileSelfExtractor 
Saving_EntryBytesRead 
Extracting_BeforeExtractEntry 
Extracting_AfterExtractEntry 
Extracting_ExtractEntryWouldOverwrite 
Extracting_EntryBytesWritten 
Extracting_BeforeExtractAll 
Extracting_AfterExtractAll 
Error_Saving 

◆ ZlibConstants

enum Aspose::Zip::ZlibConstants : int
strong
Enumerator
Z_BUF_ERROR 
Z_DATA_ERROR 
Z_STREAM_ERROR 
Z_OK 
Z_STREAM_END 
Z_NEED_DICT 
WindowBitsMax 
WindowBitsDefault 
WorkingBufferSizeDefault 
WorkingBufferSizeMin 

◆ ZlibStreamFlavor

Enumerator
DEFLATE 
ZLIB 
GZIP 

Function Documentation

◆ DECLARE_ENUM_OPERATORS()

Aspose::Zip::DECLARE_ENUM_OPERATORS ( Aspose::Zip::ZipEntryTimestamp  )