Home | Namespaces | Hierarchy | Alphabetical List | Class list | Files | Namespace Members | Class members | File members
irr::io::IWriteFile

irr::io::IWriteFile Class Reference

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

#include <IWriteFile.h>

Inheritance diagram for irr::io::IWriteFile:

irr::IReferenceCounted List of all members.

Public Member Functions

virtual const c8 * getFileName () const =0
 Get name of file.
virtual long getPos () const =0
 Get the current position in the file.
virtual bool seek (long finalPos, bool relativeMovement=false)=0
 Changes position in file.
virtual s32 write (const void *buffer, u32 sizeToWrite)=0
 Writes an amount of bytes to the file.
virtual ~IWriteFile ()
 Destructor.

Detailed Description

Interface providing write acess to a file.

Definition at line 16 of file IWriteFile.h.

Constructor & Destructor Documentation

virtual irr::io::IWriteFile::~IWriteFile (   )  [inline, virtual]
 

Destructor.

Definition at line 20 of file IWriteFile.h.

Member Function Documentation

virtual const c8* irr::io::IWriteFile::getFileName (   )  const [pure virtual]
 

Get name of file.

Returns:
File name as zero terminated character string.

virtual long irr::io::IWriteFile::getPos (   )  const [pure virtual]
 

Get the current position in the file.

Returns:
Current position in the file in bytes.

virtual bool irr::io::IWriteFile::seek (  long  finalPos,
bool  relativeMovement = false
)  [pure virtual]
 

Changes position in file.

Parameters:
finalPos Destination position in the file.
relativeMovement If set to true, the position in the file is changed relative to current position. Otherwise the position is changed from begin of file.
Returns:
True if successful, otherwise false.

virtual s32 irr::io::IWriteFile::write (  const void *  buffer,
u32  sizeToWrite
)  [pure virtual]
 

Writes an amount of bytes to the file.

Parameters:
buffer Pointer to buffer of bytes to write.
sizeToWrite Amount of bytes to write to the file.
Returns:
How much bytes were written.

The documentation for this class was generated from the following file:
The Irrlicht Engine
The Irrlicht Engine Documentation © 2003-2008 by Nikolaus Gebhardt. Generated on Sun Jun 1 07:59:17 2008 by Doxygen (1.4.2)