ClassMStdFile
(Difference between revisions)
Dahnielson (Talk | contribs) |
Dahnielson (Talk | contribs) |
||
| Line 1: | Line 1: | ||
<noinclude>{{doxybot-warning|MStdFile}}</noinclude><includeonly> | <noinclude>{{doxybot-warning|MStdFile}}</noinclude><includeonly> | ||
| − | + | {{doxybot-class|MStdFile|}} | |
| − | + | {{doxybot-member|FILE* MStdFile::m_file|None} | |
| − | + | {{doxybot-member|FILE* MStdFile::m_file|None|} | |
| − | + | {{doxybot-member|MStdFile::MStdFile|()} | |
| − | + | {{doxybot-member|MStdFile::MStdFile|()|} | |
| − | + | {{doxybot-member|MStdFile::MStdFile|(const char *path, const char *mode)} | |
| − | + | {{doxybot-member|MStdFile::MStdFile|(const char *path, const char *mode)|} | |
| − | + | {{doxybot-member|MStdFile::~MStdFile|()} | |
| − | + | {{doxybot-member|MStdFile::~MStdFile|()|} | |
| − | + | {{doxybot-member|void MStdFile::open|(const char *path, const char *mode)} | |
| − | + | {{doxybot-member|void MStdFile::open|(const char *path, const char *mode)|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. } | |
| − | 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|int MStdFile::close|()} |
| − | + | {{doxybot-member|int MStdFile::close|()|Close a file stream, if open. } | |
| − | + | {{doxybot-member|size_t MStdFile::read|(void *dest, size_t size, size_t count)} | |
| − | + | {{doxybot-member|size_t MStdFile::read|(void *dest, size_t size, size_t count)|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). } | |
| − | Close a file stream, if open. | + | {{doxybot-member|size_t MStdFile::write|(const void *str, size_t size, size_t count)} |
| − | + | {{doxybot-member|size_t MStdFile::write|(const void *str, size_t size, size_t count)|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|int MStdFile::print|(const char *format,...)} | |
| − | + | {{doxybot-member|int MStdFile::print|(const char *format,...)|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). } | |
| − | 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|int MStdFile::print|(const char *format, va_list args)} |
| − | + | {{doxybot-member|int MStdFile::print|(const char *format, va_list args)|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|int MStdFile::seek|(long offset, int whence)} | |
| − | + | {{doxybot-member|int MStdFile::seek|(long offset, int whence)|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. } | |
| − | 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|long MStdFile::tell|()} |
| − | + | {{doxybot-member|long MStdFile::tell|()|Obtains the current value of the file position indicator for the file. } | |
| − | + | {{doxybot-member|void MStdFile::rewind|()} | |
| − | + | {{doxybot-member|void MStdFile::rewind|()|Sets the file position indicator to the beginning of the file. } | |
| − | 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|bool MStdFile::isOpen|()} |
| − | + | {{doxybot-member|bool MStdFile::isOpen|()|Checks if file is open. } | |
| − | + | {{doxybot-member|void MStdFile::destroy|(void)} | |
| − | + | {{doxybot-member|void MStdFile::destroy|(void)|Destroy file stream. } | |
| − | 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|static MStdFile* MStdFile::getNew|(const char *path, const char *mode)} |
| − | + | {{doxybot-member|static MStdFile* MStdFile::getNew|(const char *path, const char *mode)|} | |
| − | + | {{doxybot-categories}} | |
| − | + | </includeonly> | |
| − | 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. | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | Obtains the current value of the file position indicator for the file. | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | Sets the file position indicator to the beginning of the file. | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | Checks if file is open. | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | Destroy file stream. | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | {{doxybot-categories}}</includeonly> | + | |
Revision as of 13:38, 8 February 2014
This page is automatically edited by Doxybot. Do not edit it manually, human! Edit instead the main page MStdFile that it is trancluded into.
