arsa  2.7
Public Member Functions | List of all members
irr::io::IFileReadCallBack Class Referenceabstract

Callback class for file read abstraction. More...

#include <irrXML.h>

Public Member Functions

virtual ~IFileReadCallBack ()
 Destructor. More...
 
virtual int read (void *buffer, int sizeToRead)=0
 Reads an amount of bytes from the file. More...
 
virtual long getSize () const =0
 Returns size of file in bytes on success or -1L on failure. More...
 

Detailed Description

Callback class for file read abstraction.

With this, it is possible to make the xml parser read in other things than just files. The Irrlicht engine is using this for example to read xml from compressed .zip files. To make the parser read in any other data, derive a class from this interface, implement the two methods to read your data and give a pointer to an instance of your implementation when calling createIrrXMLReader(), createIrrXMLReaderUTF16() or createIrrXMLReaderUTF32()

Definition at line 216 of file irrXML.h.

Constructor & Destructor Documentation

◆ ~IFileReadCallBack()

virtual irr::io::IFileReadCallBack::~IFileReadCallBack ( )
inlinevirtual

Destructor.

Definition at line 221 of file irrXML.h.

221 {}

Member Function Documentation

◆ getSize()

virtual long irr::io::IFileReadCallBack::getSize ( ) const
pure virtual

Returns size of file in bytes on success or -1L on failure.

◆ read()

virtual int irr::io::IFileReadCallBack::read ( void buffer,
int  sizeToRead 
)
pure virtual

Reads an amount of bytes from the file.

Parameters
bufferPointer to buffer where to read bytes will be written to.
sizeToReadAmount of bytes to read from the file.
Returns
Returns how much bytes were read.

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