X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6be663cf0d9c0ce48dea6c1c2f628ed376f128c0..ded4fa5b7a2a8177a6905b9b0fcda1d3dac2d0ff:/docs/latex/wx/protocol.tex?ds=sidebyside diff --git a/docs/latex/wx/protocol.tex b/docs/latex/wx/protocol.tex index 4bf5ed1353..fcc9b406c3 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} @@ -12,7 +16,7 @@ % Members % ---------------------------------------------------------------------------- -\latexignore{\rtfignore{\membersection{Members}}} +\latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxProtocol::Reconnect}\label{wxprotoreconnect} @@ -25,43 +29,62 @@ Tries to reestablish a previous opened connection (close and renegotiate connect TRUE, if the connection is established, else FALSE. % ---------------------------------------------------------------------------- - \membersection{wxProtocol::GetInputStream}\label{wxprotogetinput} \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}} 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} \func{bool}{Abort}{\void} 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} Returns TRUE, if successful, else FALSE. % ---------------------------------------------------------------------------- - \membersection{wxProtocol::GetError} \func{wxProtocolError}{GetError}{\void} -Returns the last occured error. +Returns the last occurred error. + +\twocolwidtha{7cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf wxPROTO\_NOERR}}{No error.} +\twocolitem{{\bf wxPROTO\_NETERR}}{A generic network error occurred.} +\twocolitem{{\bf wxPROTO\_PROTERR}}{An error occurred during negotiation.} +\twocolitem{{\bf wxPROTO\_CONNERR}}{The client failed to connect the server.} +\twocolitem{{\bf wxPROTO\_INVVAL}}{Invalid value.} +\twocolitem{{\bf wxPROTO\_NOHNDLR}}{.} +\twocolitem{{\bf wxPROTO\_NOFILE}}{The remote file doesn't exist.} +\twocolitem{{\bf wxPROTO\_ABRT}}{Last action aborted.} +\twocolitem{{\bf wxPROTO\_RCNCT}}{An error occurred during reconnection.} +\twocolitem{{\bf wxPROTO\_STREAM}}{Someone tried to send a command during a transfer.} +\end{twocollist} % ---------------------------------------------------------------------------- - \membersection{wxProtocol::GetContentType} \func{wxString}{GetContentType}{\void} @@ -69,7 +92,6 @@ Returns the last occured error. Returns the type of the content of the last opened stream. It is a mime-type. % ---------------------------------------------------------------------------- - \membersection{wxProtocol::SetUser} \func{void }{SetUser}{\param{const wxString\&}{ user}}