* wxStream doc update

* wxHTTP fix


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@2970 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Guilhem Lavaux
1999-07-09 17:10:49 +00:00
parent cc985face5
commit c7d9131ae5
6 changed files with 29 additions and 70 deletions

View File

@@ -11,10 +11,6 @@
<wx/stream.h>
\wxheading{See also}
\helpref{wxStreamBuffer}{wxstreambuffer}
% -----------
% ctor & dtor
% -----------
@@ -24,11 +20,6 @@
Creates a dummy input stream.
\func{}{wxInputStream}{\param{wxStreamBuffer *}{sbuf}}
Creates an input stream using the specified stream buffer \it{sbuf}. This
stream buffer can point to another stream.
\membersection{wxInputStream::\destruct{wxInputStream}}
\func{}{\destruct{wxInputStream}}{\void}
@@ -41,12 +32,6 @@ Destructor.
Returns the first character in the input queue and removes it.
\membersection{wxInputStream::InputStreamBuffer}
\func{wxStreamBuffer*}{InputStreamBuffer}{\void}
Returns the stream buffer associated with the input stream.
\membersection{wxInputStream::LastRead}
\constfunc{size\_t}{LastRead}{\void}
@@ -96,3 +81,22 @@ Changes the stream current position.
Returns the current stream position.
\membersection{wxInputStream::Ungetch}\label{wxinputstream_ungetch}
\func{size\_t}{Ungetch}{\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{bool}{Ungetch}{\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.