corona  1.0.2
Public Member Functions
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 Member Functions

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

Detailed Description

Definition at line 7 of file DefaultFileSystem.cpp.


Constructor & Destructor Documentation

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

Definition at line 9 of file DefaultFileSystem.cpp.

corona::CFile::~CFile ( ) [inline]

Definition at line 13 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:
bufferbuffer to read into
sizenumber of bytes to read
Returns:
number of bytes successfully read

Implements corona::File.

Definition at line 17 of file DefaultFileSystem.cpp.

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

Write size bytes from buffer to the file.

Parameters:
bufferbuffer that contains the data to write
sizenumber of bytes to write
Returns:
number of bytes successfully written

Implements corona::File.

Definition at line 21 of file DefaultFileSystem.cpp.

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:
positionposition relative to the mode
modewhere to seek from in the file
Returns:
true on success, false otherwise

Implements corona::File.

Definition at line 25 of file DefaultFileSystem.cpp.

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

Get current position within the file.

Returns:
current position

Implements corona::File.

Definition at line 36 of file DefaultFileSystem.cpp.


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