My Project
Public Member Functions | List of all members
ParaEngine::IWriteFile Class Referenceabstract

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

#include <IFile.h>

Public Member Functions

virtual int write (const void *buffer, int sizeToWrite)=0
 Reads an amount of bytes from the file. More...
 
virtual bool seek (int finalPos, bool relativeMovement=false)=0
 Changes position in file, returns true if successful. More...
 
virtual int getPos ()=0
 Returns the current position in the file. More...
 
virtual const char * getFileName ()=0
 Returns name of file. More...
 

Detailed Description

Interface providing write access to a file.

Member Function Documentation

§ getFileName()

virtual const char* ParaEngine::IWriteFile::getFileName ( )
pure virtual

Returns name of file.

Returns
Returns the file name as zero terminated character string.

§ getPos()

virtual int ParaEngine::IWriteFile::getPos ( )
pure virtual

Returns the current position in the file.

Returns
Returns the current position in the file in bytes.

§ seek()

virtual bool ParaEngine::IWriteFile::seek ( int  finalPos,
bool  relativeMovement = false 
)
pure virtual

Changes position in file, returns true if successful.

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 begin of file.
Returns
Returns true if successful, otherwise false.

§ write()

virtual int ParaEngine::IWriteFile::write ( const void *  buffer,
int  sizeToWrite 
)
pure virtual

Reads an amount of bytes from the file.

Parameters
bufferPointer to buffer of bytes to write.
sizeToWriteAmount of bytes to wrtie to the file.
Returns
Returns how much bytes were written.

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