X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/15d83f726c215b06f2fdd15ece40d66d2f16a01d..6b5a8c7d986d03935d4060c96c4884d5a2bf608c:/docs/latex/wx/stream.tex diff --git a/docs/latex/wx/stream.tex b/docs/latex/wx/stream.tex index 6d94bdeca1..9ff128a6ed 100644 --- a/docs/latex/wx/stream.tex +++ b/docs/latex/wx/stream.tex @@ -95,8 +95,8 @@ It returns the size of the data read. If the returned size is different of the s \func{size\_t}{Read}{\param{wxStreamBuffer *}{buffer}} -Reads a {\it buffer}. The function returns when {\it buffer} is full or when there isn't -data anymore in the current buffer. +Copies data to {\it buffer}. The function returns when {\it buffer} is full or when there isn't +any more data in the current buffer. \wxheading{See also} @@ -226,19 +226,19 @@ The created IO buffer is growable by the object. \membersection{wxStreamBuffer::GetBufferStart}\label{wxstreambuffergetbufferstart} -\constfunc{char *}{GetBufferStart}{\void} +\constfunc{void *}{GetBufferStart}{\void} Returns a pointer on the start of the stream buffer. \membersection{wxStreamBuffer::GetBufferEnd}\label{wxstreambuffergetbufferend} -\constfunc{char *}{GetBufferEnd}{\void} +\constfunc{void *}{GetBufferEnd}{\void} Returns a pointer on the end of the stream buffer. \membersection{wxStreamBuffer::GetBufferPos}\label{wxstreambuffergetbufferpos} -\constfunc{char *}{GetBufferPos}{\void} +\constfunc{void *}{GetBufferPos}{\void} Returns a pointer on the current position of the stream buffer. @@ -257,7 +257,7 @@ Sets the current position (in bytes) in the stream buffer. \wxheading{Warning} Since it is a very low-level function, there is no check on the position: -specifing an invalid position can induce unexpected results. +specifying an invalid position can induce unexpected results. \membersection{wxStreamBuffer::GetLastAccess}\label{wxstreambuffergetlastaccess} @@ -296,6 +296,12 @@ Flushes the IO buffer. Fill the IO buffer. +\membersection{wxStreamBuffer::GetBufferSize}\label{wxstreambuffergetbuffersize} + +\constfunc{size\_t}{GetBufferSize}{\void} + +Returns the size of the buffer. + \membersection{wxStreamBuffer::GetDataLeft}\label{wxstreambuffergetdataleft} \func{size\_t}{GetDataLeft}{\void}