]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/stream.tex
Don't use const bool.
[wxWidgets.git] / docs / latex / wx / stream.tex
index a0bd5a64d1bf5285f22a72464290e9fff087fa43..9262f10486575085579ed4ce8bc5e066e8a69b72 100644 (file)
@@ -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}
 
@@ -184,6 +184,17 @@ the beginning of the stream. Otherwise, it returns wxInvalidOffset.
 
 Resets to the initial state variables concerning the buffer.
 
+
+\membersection{wxStreamBuffer::Truncate}\label{wxstreambuffertruncate}
+
+\func{void}{Truncate}{\void}
+
+Truncates the buffer to the current position.
+
+Note: Truncate() cannot be used to enlarge the buffer. This is
+usually not needed since the buffer expands automatically.
+
+
 \membersection{wxStreamBuffer::SetBufferIO}\label{wxstreambuffersetbufferio}
 
 \func{void}{SetBufferIO}{\param{char*}{ buffer\_start}, \param{char*}{ buffer\_end}}
@@ -296,6 +307,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}