X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7468b994be5579ff57516f07e2d771831e73f65e..1c0f361be288df133c766e04cc857b3e4682b31a:/docs/latex/wx/strmbase.tex diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex index 1bcd9ec56b..141374c28f 100644 --- a/docs/latex/wx/strmbase.tex +++ b/docs/latex/wx/strmbase.tex @@ -3,7 +3,7 @@ % ----------------------------------------------------------------------------- \section{\class{wxStreamBase}}\label{wxstreambase} -This class is the base class of most stream related classes in wxWindows. It must +This class is the base class of most stream related classes in wxWidgets. It must not be used directly. \wxheading{Derived from} @@ -39,17 +39,28 @@ Creates a dummy stream object. It doesn't do anything. Destructor. -\membersection{wxStreamBase::LastError}\label{wxstreambaselasterror} +\membersection{wxStreamBase::IsOk}\label{wxstreambaseisok} -\constfunc{wxStreamError}{LastError}{\void} +\constfunc{wxStreamError}{IsOk}{\void} + +Returns true if no error occurred on the stream. + +\wxheading{See also} + +\helpref{GetLastError}{wxstreambasegetlasterror} + +\membersection{wxStreamBase::GetLastError}\label{wxstreambasegetlasterror} + +\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} @@ -84,14 +95,10 @@ See \helpref{OnSysRead}{wxstreambaseonsysread}. \constfunc{size\_t}{GetSize}{\void} This function returns the size of the stream. For example, for a file it is the size of -the file). +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.