Home | Namespaces | Hierarchy | Alphabetical List | Class list | Files | Namespace Members | Class members | File members | Tutorials
Public Member Functions
irr::io::IReadFile Class Reference

Interface providing read acess to a file. More...

#include <IReadFile.h>

Inheritance diagram for irr::io::IReadFile:
irr::IReferenceCounted

List of all members.

Public Member Functions

virtual const io::pathgetFileName () const =0
 Get name of file.
virtual long getPos () const =0
 Get the current position in the file.
virtual long getSize () const =0
 Get size of file.
virtual s32 read (void *buffer, u32 sizeToRead)=0
 Reads an amount of bytes from the file.
virtual bool seek (long finalPos, bool relativeMovement=false)=0
 Changes position in file.

Detailed Description

Interface providing read acess to a file.

Definition at line 17 of file IReadFile.h.


Member Function Documentation

virtual const io::path& irr::io::IReadFile::getFileName ( ) const [pure virtual]

Get name of file.

Returns:
File name as zero terminated character string.
virtual long irr::io::IReadFile::getPos ( ) const [pure virtual]

Get the current position in the file.

Returns:
Current position in the file in bytes.
virtual long irr::io::IReadFile::getSize ( ) const [pure virtual]

Get size of file.

Returns:
Size of the file in bytes.
virtual s32 irr::io::IReadFile::read ( void *  buffer,
u32  sizeToRead 
) [pure virtual]

Reads an amount of bytes from the file.

Parameters:
bufferPointer to buffer where read bytes are written to.
sizeToReadAmount of bytes to read from the file.
Returns:
How many bytes were read.
virtual bool irr::io::IReadFile::seek ( long  finalPos,
bool  relativeMovement = false 
) [pure virtual]

Changes position in file.

Parameters:
finalPosDestination position in the file.
relativeMovementIf set to true, the position in the file is changed relative to current position. Otherwise the position is changed from beginning of file.
Returns:
True if successful, otherwise false.

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

The Irrlicht Engine
The Irrlicht Engine Documentation © 2003-2010 by Nikolaus Gebhardt. Generated on Fri May 25 2012 04:23:34 by Doxygen (1.7.6.1)