X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fa482912e420a40e9f2e55a0f5407562826dd15e..eeacbb8c4ff812199e509b36329d1bb237f770a1:/docs/latex/wx/strmbase.tex diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex index 0a6a5a38ef..4daa4ceb09 100644 --- a/docs/latex/wx/strmbase.tex +++ b/docs/latex/wx/strmbase.tex @@ -43,24 +43,24 @@ Destructor. \constfunc{wxStreamError}{IsOk}{\void} -Returns TRUE if no error occured on the stream. +Returns true if no error occurred on the stream. \wxheading{See also} -\helpref{LastError}{wxstreambaselasterror} +\helpref{GetLastError}{wxstreambasegetlasterror} -\membersection{wxStreamBase::LastError}\label{wxstreambaselasterror} +\membersection{wxStreamBase::GetLastError}\label{wxstreambasegetlasterror} -\constfunc{wxStreamError}{LastError}{\void} +\constfunc{wxStreamError}{GetLastError}{\void} This function returns the last error. \twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt -\twocolitem{{\bf wxSTREAM\_NO\_ERROR}}{No error occured.} -\twocolitem{{\bf wxSTREAM\_EOF}}{An End-Of-File occured.} -\twocolitem{{\bf wxSTREAM\_WRITE\_ERROR}}{A generic error occured on the last write call.} -\twocolitem{{\bf wxSTREAM\_READ\_ERROR}}{A generic error occured on the last read call.} +\twocolitem{{\bf wxSTREAM\_NO\_ERROR}}{No error occurred.} +\twocolitem{{\bf wxSTREAM\_EOF}}{An End-Of-File occurred.} +\twocolitem{{\bf wxSTREAM\_WRITE\_ERROR}}{A generic error occurred on the last write call.} +\twocolitem{{\bf wxSTREAM\_READ\_ERROR}}{A generic error occurred on the last read call.} \end{twocollist} \membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread} @@ -100,9 +100,5 @@ the file. \wxheading{Warning} There are streams which do not have size by definition, such as socket streams. -In that cases, GetSize returns an invalid size represented by - -\begin{verbatim} -~(size_t)0 -\end{verbatim} +In that cases, GetSize returns $0$ so you should always test its return value.