Login

Home

ZipArchive Download Purchase Contact General Information How to Use History of Changes Frequently Asked Questions Newsletter Who's Using Acknowledgements Licensing Information Overview API Documentation

Home > ZipArchive > How to Use > API Documentation

ZipArchiveLib::CDeflateCompressor::COptions Struct Reference

#include <DeflateCompressor.h>

Inheritance diagram for ZipArchiveLib::CDeflateCompressor::COptions:

[legend]

List of all members.

Public Member Functions
CZipCompressor::COptions *	Clone () const
int	GetType () const
Public Attributes
bool	m_bCheckLastBlock
bool	m_bCreateOffsetsArray
int	m_iSyncRatio

---

Detailed Description

Represents options of the CDeflateCompressor.

See also:

Compressing Data

CZipArchive::SetCompressionOptions

---

Member Function Documentation

CZipCompressor::COptions* ZipArchiveLib::CDeflateCompressor::COptions::Clone

(

)

const [inline, virtual]

Clones the current options object.

Returns:

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

Implements CZipCompressor::COptions.

int ZipArchiveLib::CDeflateCompressor::COptions::GetType

(

)

const [inline, 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.

Implements CZipCompressor::COptions.

---

Member Data Documentation

bool ZipArchiveLib::CDeflateCompressor::COptions::m_bCheckLastBlock

Enables or disables checking, if the compressed data ends with an end-of-stream block. This should be enabled to protect against malformed data. true, if the checking of the last block should be enabled; false otherwise.

bool ZipArchiveLib::CDeflateCompressor::COptions::m_bCreateOffsetsArray

Specifies whether or not the CZipCompressor::COffsetsArray is created while creating synchronization blocks. true, if the offsets array should be created; false otherwise.

Note:

Normally, this value should be always set to true.

See also:

Creating Seekable Compressed Data

CDeflateCompressor::GetOffsetsArray

m_iSyncRatio

int ZipArchiveLib::CDeflateCompressor::COptions::m_iSyncRatio

Determines how often synchronization blocks are created.

• 0 - disables creation of synchronization blocks,
• the larger the value, the rarer the synchronization blocks are created and the better the compression ratio is.

Note:

This setting has no effect on stored or encrypted data. The synchronization blocks will not be created in these cases regardless of the value set.

You can use CZipCompressor::COffsetsArray::GetStatistics to determine the best value.

See also:

Creating Seekable Compressed Data

m_bCreateOffsetsArray

CDeflateCompressor::GetOffsetsArray

---

The documentation for this struct was generated from the following file:

• DeflateCompressor.h

Copyright © 2000 - 2007 Artpol Software - Tadeusz Dracz

Back To Top