io::FileInputStream Class Reference

A FileInputStream obtains input bytes from a file in a file system. What files are available depends on the host environment. More...

#include <FileInputStream.h>

Inheritance diagram for io::FileInputStream:

Inheritance graph
[legend]
Collaboration diagram for io::FileInputStream:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 FileInputStream ()
virtual ~FileInputStream ()
bool openFile (const lang::String &filename)
int32 read ()
int32 read (uint16 &data)
int32 read (char *pDataOut, int32 size)
int32 skip (int32 n)
int32 available () const
const char * toString ()


Detailed Description

A FileInputStream obtains input bytes from a file in a file system. What files are available depends on the host environment.

Note:
FileInputStream is meant for reading streams of raw bytes such as image data. For reading streams of characters, consider using FileReader.

Constructor & Destructor Documentation

io::FileInputStream::FileInputStream (  ) 

Constructor

virtual io::FileInputStream::~FileInputStream (  )  [virtual]

Destructor


Member Function Documentation

bool io::FileInputStream::openFile ( const lang::String filename  ) 

Open the desired file.

Parameters:
filename The name of file
Returns:
true if operation was a success.

int32 io::FileInputStream::read (  )  [virtual]

See also:
InputStream::read()

Implements io::InputStream.

int32 io::FileInputStream::read ( uint16 &  data  ) 

int32 io::FileInputStream::read ( char *  pDataOut,
int32  size 
) [virtual]

See also:
InputStream::read(void* pDataOut, int32 size)

Implements io::InputStream.

int32 io::FileInputStream::skip ( int32  n  )  [virtual]

See also:
InputStream::int32 skip(int32 n)

Implements io::InputStream.

int32 io::FileInputStream::available (  )  const [virtual]

const char* io::FileInputStream::toString (  )  [virtual]

See also:
Object::toString()

Implements Object.


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

Generated on Mon Mar 3 10:53:09 2008 for Aika by  doxygen 1.5.5