X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b82827dd43caa489eade15cc02edef7fb79e8c20..794005c0acc80bf21ca0ed2e1f42f1d78947957b:/docs/latex/wx/protocol.tex diff --git a/docs/latex/wx/protocol.tex b/docs/latex/wx/protocol.tex index 730514b43f..0043092d7f 100644 --- a/docs/latex/wx/protocol.tex +++ b/docs/latex/wx/protocol.tex @@ -4,6 +4,10 @@ \helpref{wxSocketClient}{wxsocketclient} +\wxheading{Include files} + + + \wxheading{See also} \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxURL}{wxurl} @@ -11,6 +15,7 @@ % ---------------------------------------------------------------------------- % Members % ---------------------------------------------------------------------------- + \latexignore{\rtfignore{\membersection{Members}}} \membersection{wxProtocol::Reconnect}\label{wxprotoreconnect} @@ -30,11 +35,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 +55,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}