* Doc updates

* Fixes about socket, stream core, a superfluous stream.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1670 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Guilhem Lavaux
1999-02-10 20:01:06 +00:00
parent 5e1962f77f
commit 7f42cff13e
12 changed files with 72 additions and 24 deletions

View File

@@ -191,6 +191,7 @@ $$\image{14cm;0cm}{wxclass.ps}$$
\input strlist.tex
\input strmbase.tex
\input stream.tex
\input strmmem.tex
\input sysclevt.tex
\input settings.tex
\input tab.tex

View File

@@ -94,3 +94,6 @@ writing data, he has to delete the stream to close it.
An initialized write-only stream.
\wxheading{See also}
\helpref{wxOutputStream}{wxoutputstream}

View File

@@ -30,11 +30,18 @@ TRUE, if the connection is established, else FALSE.
Creates a new input stream on the the specified path. You can use all but seek
functionnality of wxStream. Seek isn't available on all stream. For example,
http or ftp streams doesn't deal with it.
http or ftp streams doesn't deal with it. Other functions like StreamSize and
Tell aren't available for the moment for this sort of stream.
You will be notified when the EOF is reached by an error.
\wxheading{Return value}
Returns the initialized stream. You will have to delete it yourself.
Returns the initialized stream. You will have to delete it yourself once you
don't use it anymore. The destructor closes the network connection.
\wxheading{See also}
\helpref{wxInputStream}{wxinputstream}
% ----------------------------------------------------------------------------
\membersection{wxProtocol::Abort}\label{wxprotoabort}
@@ -43,7 +50,9 @@ Returns the initialized stream. You will have to delete it yourself.
Abort the current stream.
\it{WARNING: It is advised to destroy the input stream instead of aborting the stream this way.}
\wxheading{Warning}
It is advised to destroy the input stream instead of aborting the stream this way.
\wxheading{Return value}
@@ -89,4 +98,3 @@ Sets the authentication user. It is mainly useful when FTP is used.
\func{void}{SetPassword}{\param{const wxString\&}{ user}}
Sets the authentication password. It is mainly useful when FTP is used.

View File

@@ -48,6 +48,16 @@ functionnalities of a ``normal'' stream.
\wxheading{Warning}
The "read\_write" mode may not work: it isn't completely finished.
You can create "memory" streams by this way:
\begin{verbatim}
wxStreamBuffer *sb = new wxStreamBuffer(wxStreamBuffer::read)
wxInputStream *input = new wxInputStream(sb);
sb->Fixed(FALSE); // It can change the size of the buffer.
// input is now a read-only memory stream.
\end{verbatim}
But you should care about destroying the stream buffer \it{YOURSELF}.
\wxheading{See also}

View File

@@ -84,5 +84,5 @@ current position in the stream. See \helpref{wxStreamBuffer::Seek}{wxstreambuffe
\constfunc{off_t}{OnSysTell}{\void}
Internal function. Is is called when the stream buffer needs to know the
current position in the stream.
real position in the stream.