ClassMFile
From MaratisWiki
(Difference between revisions)
Dahnielson (Talk | contribs) |
Dahnielson (Talk | contribs) |
||
(3 intermediate revisions by one user not shown) | |||
Line 1: | Line 1: | ||
<noinclude>{{doxybot-warning|MFile}}</noinclude><includeonly> | <noinclude>{{doxybot-warning|MFile}}</noinclude><includeonly> | ||
− | {{doxybot-class|MFile| | + | {{doxybot-class|1=MFile|2=File I/O class. This interface can be used manually, but will usually be used from the MFileTools interface, to more closely match standard C file I/O. |
}} | }} | ||
− | {{doxybot-member|virtual MFile::~MFile | + | {{doxybot-member|1=virtual MFile::~MFile(void)|2=Destructor. }} |
− | + | {{doxybot-member|1=virtual void MFile::open(const char *path, const char *mode)=0|2=Opens a file stream with the name specified by path. This usually should not be used directly and should be opened from the MFileTools interface. }} | |
− | {{doxybot-member|virtual void MFile::open | + | {{doxybot-member|1=virtual int MFile::close()=0|2=Close a file stream, if open. }} |
− | + | {{doxybot-member|1=virtual size_t MFile::read(void *dest, size_t size, size_t count)=0|2=Reads count amount of elements of data, each size bytes long, from the file, storing them at the location given by dest. Returns the number of items successfully read. If an error occurs, or the end-of-file is reached, the return value is a short item count (or zero). }} | |
− | {{doxybot-member|virtual int MFile::close | + | {{doxybot-member|1=virtual size_t MFile::write(const void *str, size_t size, size_t count)=0|2=Writes count amount of elements of data, each size bytes long, to the file, obtaining them from the location given by str. Returns the number of items successfully written. }} |
− | + | {{doxybot-member|1=virtual int MFile::print(const char *format,...)=0|2=Produces output according to the standard printf() style format and writes to the file. Returns the number of characters written to the file (excluding the null byte used to end output strings). }} | |
− | {{doxybot-member|virtual size_t MFile::read | + | {{doxybot-member|1=virtual int MFile::print(const char *format, va_list args)=0|2=Produces output according to the standard printf() style format and writes to the file. Returns the number of characters written to the file (excluding the null byte used to end output strings). }} |
− | + | {{doxybot-member|1=virtual int MFile::seek(long offset, int whence)=0|2=Sets the file position indicator. The new position, measured in bytes, is obtained by adding offset bytes to the position specified by whence. If whence is set to SEEK_SET, SEEK_CUR, or SEEK_END, the offset is relative to the start of the file, the current position indicator, or end-of-file respectively. }} | |
− | {{doxybot-member|virtual size_t MFile::write | + | {{doxybot-member|1=virtual long MFile::tell()=0|2=Obtains the current value of the file position indicator for the file. }} |
− | + | {{doxybot-member|1=virtual void MFile::rewind()=0|2=Sets the file position indicator to the beginning of the file. }} | |
− | {{doxybot-member|virtual int MFile::print | + | {{doxybot-member|1=virtual bool MFile::isOpen()=0|2=Checks if file is open. }} |
− | + | {{doxybot-member|1=virtual void MFile::destroy()=0|2=Destroy file stream. }} | |
− | {{doxybot-member|virtual int MFile::print | + | |
− | + | ||
− | {{doxybot-member|virtual int MFile::seek | + | |
− | + | ||
− | {{doxybot-member|virtual long MFile::tell | + | |
− | + | ||
− | {{doxybot-member|virtual void MFile::rewind | + | |
− | + | ||
− | {{doxybot-member|virtual bool MFile::isOpen | + | |
− | + | ||
− | {{doxybot-member|virtual void MFile::destroy | + | |
− | + | ||
{{doxybot-categories}} | {{doxybot-categories}} | ||
</includeonly> | </includeonly> |
Latest revision as of 13:19, 8 February 2014
This page is automatically edited by Doxybot. Do not edit it manually, human! Edit instead the main page MFile that it is trancluded into.