X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fa482912e420a40e9f2e55a0f5407562826dd15e..21f60945831a6edad0f2101b6053a2c8213d5296:/docs/latex/wx/stream.tex diff --git a/docs/latex/wx/stream.tex b/docs/latex/wx/stream.tex index 397098dd8c..bdf3d7416b 100644 --- a/docs/latex/wx/stream.tex +++ b/docs/latex/wx/stream.tex @@ -90,7 +90,7 @@ accordingly until all requested data is read. \wxheading{Return value} It returns the size of the data read. If the returned size is different of the specified -{\it size}, an error has occured and should be tested using +{\it size}, an error has occurred and should be tested using \helpref{LastError}{wxstreambaselasterror}. \func{size\_t}{Read}{\param{wxStreamBuffer *}{buffer}} @@ -106,7 +106,7 @@ data anymore in the current buffer. \func{size\_t}{Write}{\param{const void *}{buffer}, \param{size\_t }{size}} -Writes a block of the specified {\it size} using datas of {\it buffer}. The datas +Writes a block of the specified {\it size} using data of {\it buffer}. The data are cached in a buffer before being sent in one block to the stream. \func{size\_t}{Write}{\param{wxStreamBuffer *}{buffer}} @@ -121,7 +121,7 @@ Gets a single char from the stream buffer. It acts like the Read call. \wxheading{Problem} -You aren't directly notified if an error occured during the IO call. +You aren't directly notified if an error occurred during the IO call. \wxheading{See also} @@ -135,7 +135,7 @@ Puts a single char to the stream buffer. \wxheading{Problem} -You aren't directly notified if an error occured during the IO call. +You aren't directly notified if an error occurred during the IO call. \wxheading{See also} @@ -195,7 +195,7 @@ you create an empty stream buffer (See \helpref{wxStreamBuffer::wxStreamBuffer}{ \wxheading{Remarks} -When you use this function, you'll have to destroy the IO buffers yourself +When you use this function, you will have to destroy the IO buffers yourself after the stream buffer is destroyed or don't use it anymore. In the case you use it with an empty buffer, the stream buffer will not resize it when it is full. @@ -250,14 +250,14 @@ Returns the current position (counted in bytes) in the stream buffer. \membersection{wxStreamBuffer::SetIntPosition} -\func{void}{SetIntPosition}{\void} +\func{void}{SetIntPosition}{\param{size\_t}{ pos}} 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: -specify an invalid position can induce unexpected results. +specifing an invalid position can induce unexpected results. \membersection{wxStreamBuffer::GetLastAccess} @@ -270,8 +270,8 @@ Returns the amount of bytes read during the last IO call to the parent stream. \func{void}{Fixed}{\param{bool}{ fixed}} Toggles the fixed flag. Usually this flag is toggled at the same time as -{\it flushable}. This flag allows (when it has the FALSE value) or forbids -(when it has the TRUE value) the stream buffer to resize dynamically the IO buffer. +{\it flushable}. This flag allows (when it has the false value) or forbids +(when it has the true value) the stream buffer to resize dynamically the IO buffer. \wxheading{See also} @@ -281,7 +281,7 @@ Toggles the fixed flag. Usually this flag is toggled at the same time as \func{void}{Flushable}{\param{bool}{ flushable}} -Toggles the flushable flag. If {\it flushable} is disabled, no datas are sent +Toggles the flushable flag. If {\it flushable} is disabled, no data are sent to the parent stream. \membersection{wxStreamBuffer::FlushBuffer} @@ -300,7 +300,7 @@ Fill the IO buffer. \func{size\_t}{GetDataLeft}{\void} -Returns the amount of available datas in the buffer. +Returns the amount of available data in the buffer. % -------------- % Administration