SignDoc SDK (C++)  5.0.0
FileInputStream Class Reference

Class implementing an InputStream reading from a file. More...

#include <SignDocSDK-cpp.h>

Inheritance diagram for FileInputStream:
LibraryInputStream InputStream

Public Member Functions

 FileInputStream (FILE *aFile)
 Constructor: Read from a C stream. More...
 
 FileInputStream (FILE *aFile, const char *aPath)
 Constructor: Read from a C stream. More...
 
 FileInputStream (const char *aPath)
 Constructor: Open a file in binary mode. More...
 
 FileInputStream (const wchar_t *aPath)
 Constructor: Open a file in binary mode. More...
 
- Public Member Functions inherited from LibraryInputStream
 LibraryInputStream (SIGNDOC_InputStream *aImpl)
 Constructor. More...
 
virtual int read (void *aDst, int aLen)
 Read octets from source. More...
 
virtual void close ()
 Close the stream. More...
 
virtual void seek (int aPos)
 Seek to the specified position (int). More...
 
virtual int tell () const
 Retrieve the current position (int). More...
 
virtual int getAvailable ()
 Get an estimate of the number of octets available for reading. More...
 
- Public Member Functions inherited from InputStream
 InputStream (SIGNDOC_InputStream *aImpl)
 Constructor. More...
 
virtual ~InputStream ()
 Destructor. More...
 
SIGNDOC_InputStream * getImpl ()
 Internal. More...
 

Additional Inherited Members

- Protected Attributes inherited from InputStream
SIGNDOC_InputStream * p
 Pointer to C structure. More...
 

Detailed Description

Class implementing an InputStream reading from a file.

If possible, any exception thrown by member functions of this class contain the pathname. Note that the pathname will be UTF-8 encoded.

Constructor & Destructor Documentation

FileInputStream ( FILE *  aFile)
inline

Constructor: Read from a C stream.

Parameters
[in]aFileThe C stream to be wrapped.
FileInputStream ( FILE *  aFile,
const char *  aPath 
)
inline

Constructor: Read from a C stream.

Parameters
[in]aFileThe C stream to be wrapped.
[in]aPathThe pathname (native encoding), used in exceptions, can be NULL.
FileInputStream ( const char *  aPath)
inline

Constructor: Open a file in binary mode.

Throws an exception on error.

Parameters
[in]aPathThe pathname of the file to be opened (native encoding).
FileInputStream ( const wchar_t *  aPath)
inline

Constructor: Open a file in binary mode.

Throws an exception on error.

Parameters
[in]aPathThe pathname of the file to be opened.

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