Public Member Functions

PoDoFo::PdfMemoryOutputStream Class Reference

#include <PdfOutputStream.h>

Inheritance diagram for PoDoFo::PdfMemoryOutputStream:
PoDoFo::PdfOutputStream

List of all members.

Public Member Functions

 PdfMemoryOutputStream (pdf_long lInitial=INITIAL_SIZE)
 PdfMemoryOutputStream (char *pBuffer, pdf_long lLen)
virtual pdf_long Write (const char *pBuffer, pdf_long lLen)
virtual void Close ()
pdf_long GetLength () const
char * TakeBuffer ()

Detailed Description

An output stream that writes data to a memory buffer If the buffer is to small, it will be enlarged automatically.

DS: TODO: remove in favour of PdfBufferOutputStream.


Constructor & Destructor Documentation

PoDoFo::PdfMemoryOutputStream::PdfMemoryOutputStream ( pdf_long  lInitial = INITIAL_SIZE  ) 

Construct a new PdfMemoryOutputStream

Parameters:
lInitial initial size of the buffer
PoDoFo::PdfMemoryOutputStream::PdfMemoryOutputStream ( char *  pBuffer,
pdf_long  lLen 
)

Construct a new PdfMemoryOutputStream that writes to an existing buffer

Parameters:
pBuffer handle to the buffer
lLen length of the buffer

Member Function Documentation

virtual void PoDoFo::PdfMemoryOutputStream::Close (  )  [inline, virtual]

Close the PdfOutputStream. This method may throw exceptions and has to be called before the descructor to end writing.

No more data may be written to the output device after calling close.

Implements PoDoFo::PdfOutputStream.

pdf_long PoDoFo::PdfMemoryOutputStream::GetLength (  )  const [inline]
Returns:
the length of the written data
char * PoDoFo::PdfMemoryOutputStream::TakeBuffer (  )  [inline]
Returns:
a handle to the internal buffer.

The internal buffer is now owned by the caller and will not be deleted by PdfMemoryOutputStream. Further calls to write are not allowed.

The caller has to free the returned malloc'ed buffer!

pdf_long PoDoFo::PdfMemoryOutputStream::Write ( const char *  pBuffer,
pdf_long  lLen 
) [virtual]

Write data to the output stream

Parameters:
pBuffer the data is read from this buffer
lLen the size of the buffer
Returns:
the number of bytes written, -1 if an error ocurred

Implements PoDoFo::PdfOutputStream.