DWFCore::DWFZippingOutputStream Class Reference

#include "dwfcore/ZippingOutputStream.h"

Inheritance diagram for DWFCore::DWFZippingOutputStream:

Inheritance graph
[legend]
Collaboration diagram for DWFCore::DWFZippingOutputStream:

Collaboration graph
[legend]
List of all members.

Detailed Description

An output stream object that uses the zip library to archive files. from another stream.

Since:
1.0.1

Definition at line 46 of file ZippingOutputStream.h.

Public Member Functions

_DWFCORE_API DWFZippingOutputStream (zipFile pZipStream, DWFZipFileDescriptor::teFileMode eZipMode) throw ()
virtual _DWFCORE_API ~DWFZippingOutputStream () throw ()
_DWFCORE_API void open (const DWFString &zArchiveFile, const DWFString &zPassword="", bool bPKZIPCompliantPassword=true) throw ( DWFException )
_DWFCORE_API void flush () throw ( DWFException )
_DWFCORE_API size_t write (const void *pBuffer, size_t nBytesToWrite) throw ( DWFException )


Constructor & Destructor Documentation

_DWFCORE_API DWFCore::DWFZippingOutputStream::DWFZippingOutputStream zipFile  pZipStream,
DWFZipFileDescriptor::teFileMode  eZipMode
throw ()
 

Constructor

Parameters:
pZipStream This data structure representing the file stream is obtained from the zip library.
eZipMode This enumeration controls the level of compression to be used when deflating the data. Note that DWFZipFileDescriptor::eUnzip is an invalid option for this method.
Exceptions:
None 

virtual _DWFCORE_API DWFCore::DWFZippingOutputStream::~DWFZippingOutputStream  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

_DWFCORE_API void DWFCore::DWFZippingOutputStream::flush  )  throw ( DWFException ) [virtual]
 

Writes any remaining bytes from the stream into the data sink. This method may not have any function for some implementations. It is recommended that, rather than throwing an exception, the method simply return.

Exceptions:
DWFException 

Implements DWFCore::DWFOutputStream.

_DWFCORE_API void DWFCore::DWFZippingOutputStream::open const DWFString zArchiveFile,
const DWFString zPassword = "",
bool  bPKZIPCompliantPassword = true
throw ( DWFException )
 

Prepares the stream to archive the given file.

Parameters:
zArchiveFile The full path name of the file in the archive.
zPassword An optional password to protect the archive.
bPKZIPCompliantPassword An optional boolean to control whether passwording is PKZIP compliant, or if it should use a more secure, custom, form of passwording. The default is true, meaning compliant.
Exceptions:
DWFException 

_DWFCORE_API size_t DWFCore::DWFZippingOutputStream::write const void *  pBuffer,
size_t  nBytesToWrite
throw ( DWFException ) [virtual]
 

Writes at most nBytesToWrite into the stream from the buffer provided.

Parameters:
pBuffer A pointer to a block of memory whose data will be written into the stream. Any implementation receiving a NULL buffer pointer should throw a DWFInvalidArgumentException.
nBytesToWrite The number of bytes to copy from pBuffer.
Returns:
The number of bytes actually written.
Exceptions:
DWFException 

Implements DWFCore::DWFOutputStream.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:39:44 2009 for Autodesk DWF Core Library by  doxygen 1.4.5