X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c7f49969d61742050e2caaf27528bdb96ffc8365..a14e57f9f7d2e2b3b5d5aa7bf323efe907485408:/docs/latex/wx/stream.tex diff --git a/docs/latex/wx/stream.tex b/docs/latex/wx/stream.tex index 69395451d0..95e166b23a 100644 --- a/docs/latex/wx/stream.tex +++ b/docs/latex/wx/stream.tex @@ -4,6 +4,10 @@ None +\wxheading{Include files} + + + \wxheading{See also} \helpref{wxStreamBase}{wxstreambase} @@ -30,10 +34,11 @@ can call directly wxStreamBuffer::Read without any problems. \wxheading{Warning} All errors and messages linked to the stream are stored in the stream object. + \begin{verbatim} - streambuffer.Read(...); - streambuffer2.Read(...); /* This one erases previous error messages set by - ``streambuffer'' */ + streambuffer.Read(...); + streambuffer2.Read(...); /* This one erases previous error messages set by + ``streambuffer'' */ \end{verbatim} \func{}{wxStreamBuffer}{\param{BufMode}{ mode}} @@ -110,7 +115,7 @@ It returns the real read size. If returned size is different of the specified \wxheading{See also} -\helpref{wxStreamBuffer::WriteBack}{wxstreambufferwriteback} +\helpref{wxStreamBuffer::Write}{wxstreambufferwrite} \func{size\_t}{Read}{\param{wxStreamBuffer *}{buffer}} @@ -128,25 +133,6 @@ are cached in a buffer before being sent in one block to the stream. See \helpref{Read}{wxstreambufferread}. -\membersection{wxStreamBuffer::WriteBack}\label{wxstreambufferwriteback} - -\func{size\_t}{WriteBack}{\param{const char*}{ buffer}, \param{size\_t}{ size}} - -This function is only useful in \it{read} mode. It is the manager of the "Write-Back" -buffer. This buffer acts like a temporary buffer where datas which has to be -read during the next read IO call are put. This is useful when you get a big -block of data which you didn't want to read: you can replace them at the top -of the input queue by this way. - -\wxheading{Return value} - -Returns the amount of bytes saved in the Write-Back buffer. - -\func{size\_t}{WriteBack}{\param{char }{c}} - -This function acts like the previous one except that it takes only one -character: it is sometimes shorter to use than the generic function. - \membersection{wxStreamBuffer::GetChar} \func{char}{GetChar}{\void}