#include <FileInputStream.h>
List of all members.
Detailed Description
Implements a input stream to read out of a file
Constructor & Destructor Documentation
| zeus::TFileInputStream::TFileInputStream |
( |
const IString & |
strFilename ) |
|
| zeus::TFileInputStream::TFileInputStream |
( |
TFile & |
rFile ) |
|
| virtual zeus::TFileInputStream::~TFileInputStream |
( |
) |
[protected, virtual] |
Member Function Documentation
| virtual void MQUALIFIER zeus::TFileInputStream::close |
( |
) |
[virtual] |
| Int zeus::TFileInputStream::getPos |
( |
) |
const |
| virtual bool MQUALIFIER zeus::TFileInputStream::isEndReached |
( |
) |
const [virtual] |
This method checks if the stream is at the end. If a stream is at the end the methods readDouble(), readLong(), readByte() and readBool() should not called anymore. They will return zero. You must call this method before getting data from the stream.
- Return values:
-
| true | : Stream is at the end |
| false | : Stream is not at the end |
Implements zeus::TAbstractInputStream.
| virtual Retval MQUALIFIER zeus::TFileInputStream::read |
( |
char * |
pBuffer, |
|
|
Int |
iBufferSize, |
|
|
Int & |
rValidSize |
|
) |
| const [virtual] |
Reads from a stream into a buffer
- Parameters:
-
| pBuffer | : Char Array |
| iBufferSize | : Size of the Array |
| rValidSize | : Length of the read buffer (return parameter) |
- Return values:
-
| RET_NOERROR | : Reading was successful |
| RET_REQUEST_FAILED | : Could not read from Socket |
Implements zeus::TAbstractInputStream.
| virtual Int MQUALIFIER zeus::TFileInputStream::readItem |
( |
) |
const [virtual] |
Reads a single item from a stream. The size of item is 8bit large.
- Returns:
- item value. If the stream has an error INVALID_DATA is returned.
Implements zeus::TAbstractInputStream.
| virtual void MQUALIFIER zeus::TFileInputStream::reset |
( |
) |
[virtual] |
| bool zeus::TFileInputStream::setPos |
( |
Int |
iPos ) |
|
| virtual bool MQUALIFIER zeus::TFileInputStream::skip |
( |
Int |
iBytes = 1 ) |
[virtual] |
This method is used to skip a number of bytes
- Parameters:
-
| iBytes | : Number of bytes to skip (default = 1) |
- Return values:
-
| true | : Byte skipped |
| false,: | Error or end of stream reached |
Implements zeus::TAbstractInputStream.
The documentation for this class was generated from the following file:
