X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..d45d30c8682f858321600e2958167d7ef54ebeb5:/docs/latex/wx/strmbase.tex?ds=sidebyside diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex index b04bcdd83b..5cc9320525 100644 --- a/docs/latex/wx/strmbase.tex +++ b/docs/latex/wx/strmbase.tex @@ -43,50 +43,52 @@ Destructor. This function returns the last error. \twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt -\twocolitem{{\bf wxStream_NOERROR}}{No error occured.} -\twocolitem{{\bf wxStream_EOF}}{An End-Of-File occured.} -\twocolitem{{\bf wxStream_WRITE_ERR}}{A generic error occured on the last write call.} -\twocolitem{{\bf wxStream_READ_ERR}}{A generic error occured on the last read call.} +\twocolitem{{\bf wxStream\_NOERROR}}{No error occured.} +\twocolitem{{\bf wxStream\_EOF}}{An End-Of-File occured.} +\twocolitem{{\bf wxStream\_WRITE\_ERR}}{A generic error occured on the last write call.} +\twocolitem{{\bf wxStream\_READ\_ERR}}{A generic error occured on the last read call.} \end{twocollist} -\membersection{wxStreamBase::StreamSize} -\constfunc{size_t}{StreamSize}{\void} - -This function returns the size of the stream. For example, for a file it is the size of -the file). - -\wxheading{Warning} - -There are streams which do not have size by definition, such as socket streams. -In that cases, StreamSize returns an invalid size represented by -\begin{verbatim} -~(size_t)0 -\end{verbatim} - \membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread} -\func{size_t}{OnSysRead}{\param{void*}{ buffer}, \param{size_t}{ bufsize}} +\func{size\_t}{OnSysRead}{\param{void*}{ buffer}, \param{size\_t}{ bufsize}} Internal function. It is called when the stream buffer needs a buffer of the specified size. It should return the size that was actually read. -\membersection{wxStreamBase::OnSysWrite} - -\func{size_t}{OnSysWrite}{\param{void *}{buffer}, \param{size_t}{ bufsize}} - -See \helpref{OnSysRead}{wxstreambaseonsysread}. - \membersection{wxStreamBase::OnSysSeek} -\func{off_t}{OnSysSeek}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode}} +\func{off\_t}{OnSysSeek}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}} Internal function. It is called when the stream buffer needs to change the current position in the stream. See \helpref{wxStreamBuffer::Seek}{wxstreambufferseek} \membersection{wxStreamBase::OnSysTell} -\constfunc{off_t}{OnSysTell}{\void} +\constfunc{off\_t}{OnSysTell}{\void} Internal function. Is is called when the stream buffer needs to know the real position in the stream. +\membersection{wxStreamBase::OnSysWrite} + +\func{size\_t}{OnSysWrite}{\param{void *}{buffer}, \param{size\_t}{ bufsize}} + +See \helpref{OnSysRead}{wxstreambaseonsysread}. + +\membersection{wxStreamBase::GetSize}\label{wxstreambasegetsize} + +\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). + +\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} +