]> git.saurik.com Git - wxWidgets.git/commitdiff
even more docs for wxFile::Eof
authorVadim Zeitlin <vadim@wxwidgets.org>
Wed, 8 Dec 1999 15:22:18 +0000 (15:22 +0000)
committerVadim Zeitlin <vadim@wxwidgets.org>
Wed, 8 Dec 1999 15:22:18 +0000 (15:22 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@4878 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/latex/wx/file.tex

index 79260df675c112fdab7ee52e7d92cf5faa7e9c1e..172667c788e69ab7cfc7798deef6fe85c0d099fe 100644 (file)
@@ -149,12 +149,18 @@ Returns the file descriptor associated with the file.
 
 \constfunc{bool}{Eof}{\void}
 
-Returns TRUE if the end of the file has been reached (the last byte has been read).
-
-Note that the behaviour of the file pointer based class
-\helpref{wxFFile}{wxffile} is different as \helpref{wxFFile::Eof}{wxffileeof}
-will return TRUE here only if an attempt has been made to read
-{\it past} the last byte of the file.
+Returns TRUE if the end of the file has been reached.
+
+Note that the behaviour of the file pointer based class 
+\helpref{wxFFile}{wxffile} is different as \helpref{wxFFile::Eof}{wxffileeof} 
+will return TRUE here only if an attempt has been made to read 
+{\it past} the last byte of the file, while wxFile::Eof() will return TRUE
+even before such attempt is made if the file pointer is at the last position
+in the file.
+
+Note also that this function doesn't work on unseekable file descriptors
+(examples include pipes, terminals and sockets under Unix) and an attempt to
+use it will result in an error message in such case.
 
 \membersection{wxFile::Exists}\label{wxfileexists}