SignDoc SDK (C++)  5.0.0
LibraryOutputStream Class Reference

Base class for OutputStream implementations in SignDoc SDK. More...

#include <SignDocSDK-cpp.h>

Inheritance diagram for LibraryOutputStream:
OutputStream FileOutputStream MemoryOutputStream

Public Member Functions

 LibraryOutputStream (SIGNDOC_OutputStream *aImpl)
 Constructor. More...
 
virtual void close ()
 Close the stream. More...
 
virtual void flush ()
 Flush the stream. More...
 
virtual void write (const void *aSrc, int aLen)
 Write octets to the stream. More...
 
virtual void seek (int aPos)
 Seek to the specified position. More...
 
virtual int tell () const
 Retrieve the current position. More...
 
- Public Member Functions inherited from OutputStream
 OutputStream (SIGNDOC_OutputStream *aImpl)
 Constructor. More...
 
virtual ~OutputStream ()
 Destructor. More...
 
SIGNDOC_OutputStream * getImpl ()
 Internal. More...
 

Additional Inherited Members

- Protected Attributes inherited from OutputStream
SIGNDOC_OutputStream * p
 Pointer to C structure. More...
 

Detailed Description

Base class for OutputStream implementations in SignDoc SDK.

Constructor & Destructor Documentation

LibraryOutputStream ( SIGNDOC_OutputStream *  aImpl)
inline

Constructor.

Parameters
[in]aImplA pointer to the C structure.

Member Function Documentation

virtual void close ( )
inlinevirtual

Close the stream.

This function forces any buffered data to be written and closes the stream.

You should not write to the stream after calling this function.

Implementations of this class may define exceptions thrown by this function.

Implements OutputStream.

virtual void flush ( )
inlinevirtual

Flush the stream.

This function forces any buffered data to be written.

Implementations of this class may define exceptions thrown by this function.

Implements OutputStream.

virtual void seek ( int  aPos)
inlinevirtual

Seek to the specified position.

Throws an exception if the position is invalid or if seeking is not supported.

Parameters
[in]aPosThe position (the first octet is at position zero).

Implements OutputStream.

virtual int tell ( ) const
inlinevirtual

Retrieve the current position.

Throws an exception if the position cannot represented as non-negative int or if seeking is not supported.

Returns
The current position (the first octet is at position zero)

Implements OutputStream.

virtual void write ( const void *  aSrc,
int  aLen 
)
inlinevirtual

Write octets to the stream.

Throws an exception on error.

Parameters
[in]aSrcPointer to buffer to be written.
[in]aLenNumber of octets to write.

Implements OutputStream.


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