jpp::io::IFileReadCallBack Class Reference

Callback class for file read abstraction. More...

#include <jimcpp/core/engine/irrXML.hpp>

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

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 Jimcpp 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()

Member Function Documentation

read()

virtual int jpp::io::IFileReadCallBack::read ( void *  buffer, int  sizeToRead  )

pure virtual

Reads an amount of bytes from the file.

Parameters

buffer	Pointer to buffer where to read bytes will be written to.
sizeToRead	Amount 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:

• include/jimcpp/core/engine/irrXML.hpp