Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

corona::CFile Class Reference

Inheritance diagram for corona::CFile:

Inheritance graph
[legend]
Collaboration diagram for corona::CFile:

Collaboration graph
[legend]
List of all members.

Public Methods

 CFile (FILE *file)
 ~CFile ()
int COR_CALL read (void *buffer, int size)
int COR_CALL write (const void *buffer, int size)
bool COR_CALL seek (int position, SeekMode mode)
int COR_CALL tell ()

Constructor & Destructor Documentation

corona::CFile::CFile FILE *    file [inline]
 

Definition at line 8 of file DefaultFileSystem.cpp.

corona::CFile::~CFile   [inline]
 

Definition at line 12 of file DefaultFileSystem.cpp.


Member Function Documentation

int COR_CALL corona::CFile::read void *    buffer,
int    size
[inline, virtual]
 

Read size bytes from the file, storing them in buffer.

Parameters:
buffer buffer to read into
size number of bytes to read
Returns:
number of bytes successfully read

Implements corona::File.

Definition at line 16 of file DefaultFileSystem.cpp.

References COR_CALL, and corona::hidden::size.

int COR_CALL corona::CFile::write const void *    buffer,
int    size
[inline, virtual]
 

Write size bytes from buffer to the file.

Parameters:
buffer buffer that contains the data to write
size number of bytes to write
Returns:
number of bytes successfully written

Implements corona::File.

Definition at line 20 of file DefaultFileSystem.cpp.

References COR_CALL, and corona::hidden::size.

bool COR_CALL corona::CFile::seek int    position,
SeekMode    mode
[inline, virtual]
 

Jump to a new position in the file, using the specified seek mode. Remember: if mode is END, the position must be negative, to seek backwards from the end of the file into its contents. If the seek fails, the current position is undefined.

Parameters:
position position relative to the mode
mode where to seek from in the file
Returns:
true on success, false otherwise

Implements corona::File.

Definition at line 24 of file DefaultFileSystem.cpp.

References corona::File::BEGIN, COR_CALL, corona::File::CURRENT, corona::File::END, and corona::File::SeekMode.

int COR_CALL corona::CFile::tell   [inline, virtual]
 

Get current position within the file.

Returns:
current position

Implements corona::File.

Definition at line 35 of file DefaultFileSystem.cpp.

References COR_CALL.


The documentation for this class was generated from the following file:
Generated on Thu Oct 2 13:00:14 2003 for corona by doxygen1.3-rc1