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

CZipExtraData Class Reference

#include <ZipExtraData.h>

List of all members.


Public Member Functions

 CZipExtraData (WORD uHeaderID)
 CZipExtraData (const CZipExtraData &extra)
WORD GetHeaderID () const
int GetTotalSize () const
bool operator!= (const CZipExtraData &extra)
bool operator< (const CZipExtraData &extra)
bool operator<= (const CZipExtraData &extra)
CZipExtraDataoperator= (const CZipExtraData &extra)
bool operator== (const CZipExtraData &extra)
bool operator> (const CZipExtraData &extra)
bool operator>= (const CZipExtraData &extra)

Public Attributes

CZipAutoBuffer m_data

Protected Member Functions

bool Read (char *buffer, WORD uSize)
WORD Write (char *buffer) const

Friends

class CZipExtraField

Detailed Description

Represents a single data record in an extra field.

See also:
Providing Custom Data: Extra Fields

Constructor & Destructor Documentation

CZipExtraData::CZipExtraData ( WORD  uHeaderID  )  [inline]

Initializes a new instance of the CZipExtraData class.

Parameters:
uHeaderID The unique ID of the data.


Member Function Documentation

WORD CZipExtraData::GetHeaderID (  )  const [inline]

Gets the data ID.

Returns:
The data ID.

int CZipExtraData::GetTotalSize (  )  const [inline]

Gets the total size, the extra data will occupy in the archive.

Returns:
The size in bytes.

bool CZipExtraData::Read ( char *  buffer,
WORD  uSize 
) [protected]

Reads the extra data record from buffer.

Parameters:
buffer The buffer to read the data from.
uSize The size of the data to read.
Returns:
false, if uSize was smaller than the declared extra data size; true otherwise.

WORD CZipExtraData::Write ( char *  buffer  )  const [protected]

Writes the extra data record to buffer.

Parameters:
buffer The buffer to write to.
Returns:
The total size of extra data in bytes.


Member Data Documentation

CZipAutoBuffer CZipExtraData::m_data

The custom data contained by this record.


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