X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/57bf907d8e45ced18486d74c04f41c06034b7e65..62960a2c6e9c54720126a7207fa47e9e539f6040:/interface/wx/file.h diff --git a/interface/wx/file.h b/interface/wx/file.h index 18e138400d..10efe6534d 100644 --- a/interface/wx/file.h +++ b/interface/wx/file.h @@ -129,6 +129,18 @@ public: */ void Discard(); + /** + Flush the data written to the file to disk. + + This simply calls wxFile::Flush() for the underlying file and may be + necessary with file systems such as XFS and Ext4 under Linux. Calling + this function may however have serious performance implications and + also is not necessary with many other file systems so it is not done by + default -- but you can call it before calling Commit() to absolutely + ensure that the data was indeed written to the disk correctly. + */ + bool Flush(); + /** Returns @true if the file was successfully opened. */ @@ -137,7 +149,7 @@ public: /** Returns the length of the file. - This method may return wxInvalidOffset if the length couldn't be + This method may return ::wxInvalidOffset if the length couldn't be determined or 0 even for non-empty files if the file is not seekable. In general, the only way to determine if the file for which this function @@ -162,7 +174,7 @@ public: wxSeekMode mode = wxFromStart); /** - Returns the current position or wxInvalidOffset if file is not opened or + Returns the current position or ::wxInvalidOffset if file is not opened or if another error occurred. */ wxFileOffset Tell() const; @@ -383,7 +395,7 @@ public: @param count Bytes to read - @return The number of bytes read, or the symbol wxInvalidOffset. + @return The number of bytes read, or the symbol ::wxInvalidOffset. */ ssize_t Read(void* buffer, size_t count); @@ -395,7 +407,7 @@ public: @param mode One of wxFromStart, wxFromEnd, wxFromCurrent. - @return The actual offset position achieved, or wxInvalidOffset on + @return The actual offset position achieved, or ::wxInvalidOffset on failure. */ wxFileOffset Seek(wxFileOffset ofs, @@ -409,13 +421,13 @@ public: @param ofs Number of bytes before the end of the file. - @return The actual offset position achieved, or wxInvalidOffset on + @return The actual offset position achieved, or ::wxInvalidOffset on failure. */ wxFileOffset SeekEnd(wxFileOffset ofs = 0); /** - Returns the current position or wxInvalidOffset if file is not opened or + Returns the current position or ::wxInvalidOffset if file is not opened or if another error occurred. */ wxFileOffset Tell() const;