Skip Navigation Links
Skip Navigation LinksHome > ZipArchive > How to Use > API Documentation

CZipCompressor::COptions Struct Reference

#include <ZipCompressor.h>

Inheritance diagram for CZipCompressor::COptions:

List of all members.


Public Types

enum  Constants { cDefaultBufferSize = 2 * 65536 }

Public Member Functions

virtual COptionsClone () const =0
virtual int GetType () const =0

Public Attributes

int m_iBufferSize

Detailed Description

The base class for compressors options.

See also:
Compressing Data

CZipArchive::SetCompressionOptions


Member Enumeration Documentation

Helper constants.

Enumerator:
cDefaultBufferSize  The default size of the buffer used in compression and decompression operations.


Member Function Documentation

virtual COptions* CZipCompressor::COptions::Clone (  )  const [pure virtual]

Clones the current options object.

Returns:
The cloned object of the same type as the current object.

Implemented in ZipArchiveLib::CDeflateCompressor::COptions, and ZipArchiveLib::CBzip2Compressor::COptions.

virtual int CZipCompressor::COptions::GetType (  )  const [pure virtual]

Gets the type of the compressor to which the current options apply.

Returns:
The type of the compressor. It can be one of the CompressorType values.

Implemented in ZipArchiveLib::CDeflateCompressor::COptions, and ZipArchiveLib::CBzip2Compressor::COptions.


Member Data Documentation

The size of the buffer used in compression and decompression operations. By default it is set to to cDefaultBufferSize. For the optimal performance of the deflate algorithm it should be set at least to 128kB.

See also:
CZipArchive::SetAdvanced


The documentation for this struct was generated from the following file:
Back To Top Up