X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e694c22c31908a1fe35736e8f3d687a83d8b4892..5cb9148949accebddf960b1ca959f83a168883bf:/docs/latex/wx/file.tex diff --git a/docs/latex/wx/file.tex b/docs/latex/wx/file.tex index 79260df675..8d799e648c 100644 --- a/docs/latex/wx/file.tex +++ b/docs/latex/wx/file.tex @@ -114,7 +114,7 @@ values of wxFile::read or wxFile::write really make sense here. Attaches an existing file descriptor to the wxFile object. Example of predefined file descriptors are 0, 1 and 2 which correspond to stdin, stdout and stderr (and -have symbolic names of wxFile::fd\_stdin, wxFile::fd\_stdout and wxFile::fd\_stderr). +have symbolic names of {\bf wxFile::fd\_stdin}, {\bf wxFile::fd\_stdout} and {\bf wxFile::fd\_stderr}). The descriptor should be already opened and it will be closed by wxFile object. @@ -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). +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. +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} @@ -446,7 +452,7 @@ Returns the current position. \membersection{wxFFile::Write}\label{wxffilewrite} -\func{size_t}{Write}{\param{const void*}{ buffer}, \param{size\_t}{ count}} +\func{size\_t}{Write}{\param{const void*}{ buffer}, \param{size\_t}{ count}} Writes the specified number of bytes from a buffer.