X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/992ff3310e25b3cfa91685e04e38f28d1b36f262..5b88a837ba75928cd3835a6b97ae2bf5ad983a6e:/interface/wx/file.h diff --git a/interface/wx/file.h b/interface/wx/file.h index 6b32e84dca..30269c2e53 100644 --- a/interface/wx/file.h +++ b/interface/wx/file.h @@ -102,6 +102,8 @@ class wxTempFile public: /** Associates wxTempFile with the file to be replaced and opens it. + + @warning You should use IsOpened() to verify that the constructor succeeded. */ wxTempFile(const wxString& strName); @@ -135,7 +137,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 @@ -160,7 +162,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; @@ -248,6 +250,9 @@ public: The filename. @param mode The mode in which to open the file. + + @warning + You should use IsOpened() to verify that the constructor succeeded. */ wxFile(const wxString& filename, wxFile::OpenMode mode = wxFile::read); @@ -378,7 +383,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); @@ -390,7 +395,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, @@ -404,13 +409,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;