iFile Struct Reference
[Virtual File System (VFS)]
A replacement for FILE type in the virtual file space.
More...
#include <vfs.h>
Inheritance diagram for iFile:

Public Methods | |
virtual const char * | GetName ()=0 |
Query file name (in VFS). | |
virtual size_t | GetSize ()=0 |
Query file size. | |
virtual int | GetStatus ()=0 |
Check (and clear) file last error status. | |
virtual size_t | Read (char *Data, size_t DataSize)=0 |
Read DataSize bytes and place them into the buffer at which Data points. | |
virtual size_t | Write (const char *Data, size_t DataSize)=0 |
Write DataSize bytes from the buffer at which Data points. | |
virtual void | Flush ()=0 |
Flush stream. | |
virtual bool | AtEOF ()=0 |
Returns true if the stream is at end-of-file, else false. | |
virtual size_t | GetPos ()=0 |
Query current file pointer. | |
virtual bool | SetPos (size_t newpos)=0 |
Set new file pointer. | |
virtual csPtr< iDataBuffer > | GetAllData (bool nullterm=false)=0 |
Request whole content of the file as a single data buffer. |
Detailed Description
A replacement for FILE type in the virtual file space.
Main creators of instances implementing this interface:
Definition at line 110 of file vfs.h.
Member Function Documentation
|
Returns true if the stream is at end-of-file, else false.
Implemented in csMemFile, and csPhysicalFile. |
|
Flush stream.
Implemented in csMemFile, and csPhysicalFile. |
|
Request whole content of the file as a single data buffer.
Implemented in csMemFile, and csPhysicalFile. |
|
Query file name (in VFS).
Implemented in csMemFile, and csPhysicalFile. |
|
Query current file pointer.
Implemented in csMemFile, and csPhysicalFile. |
|
Query file size.
Implemented in csMemFile, and csPhysicalFile. |
|
Check (and clear) file last error status.
Implemented in csMemFile, and csPhysicalFile. |
|
Read DataSize bytes and place them into the buffer at which Data points.
Implemented in csMemFile, and csPhysicalFile. |
|
Set new file pointer.
Implemented in csMemFile, and csPhysicalFile. |
|
Write DataSize bytes from the buffer at which Data points.
Implemented in csMemFile, and csPhysicalFile. |
The documentation for this struct was generated from the following file:
- iutil/vfs.h
Generated for Crystal Space by doxygen 1.2.18