X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7d2946d285c11f5cf187db418c2e6093100af7a7..294ea16de3359844cb884baad219b40ea04fac48:/docs/latex/wx/protocol.tex diff --git a/docs/latex/wx/protocol.tex b/docs/latex/wx/protocol.tex index 7cf0aed0c1..905ca5c410 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,9 +16,9 @@ % Members % ---------------------------------------------------------------------------- -\latexignore{\rtfignore{\membersection{Members}}} +\latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxProtocol::Reconnect}\label{wxprotoreconnect} +\membersection{wxProtocol::Reconnect}\label{wxprotocolreconnect} \func{bool}{Reconnect}{\void} @@ -22,61 +26,81 @@ Tries to reestablish a previous opened connection (close and renegotiate connect \wxheading{Return value} -TRUE, if the connection is established, else FALSE. +true, if the connection is established, else false. % ---------------------------------------------------------------------------- - -\membersection{wxProtocol::GetInputStream}\label{wxprotogetinput} +\membersection{wxProtocol::GetInputStream}\label{wxprotocolgetinput} \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. +functionality of wxStream. Seek isn't available on all stream. For example, +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} -\membersection{wxProtocol::Abort}\label{wxprotoabort} +\helpref{wxInputStream}{wxinputstream} -\func{bool }{Abort}{\void} +% ---------------------------------------------------------------------------- +\membersection{wxProtocol::Abort}\label{wxprotocolabort} -Abort the current stream. -\it{WARNING: It is advised to destroy the input stream instead of aborting the stream this way.} +\func{bool}{Abort}{\void} -\wxheading{Return value} - -Returns TRUE, if successful, else FALSE. +Abort the current stream. -% ---------------------------------------------------------------------------- +\wxheading{Warning} -\membersection{wxProtocol::GetError} +It is advised to destroy the input stream instead of aborting the stream this way. -\func{wxProtocolError }{GetError}{\void} +\wxheading{Return value} -Returns the last occured error. +Returns true, if successful, else false. % ---------------------------------------------------------------------------- +\membersection{wxProtocol::GetError}\label{wxprotocolgeterror} + +\func{wxProtocolError}{GetError}{\void} + +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} +% ---------------------------------------------------------------------------- +\membersection{wxProtocol::GetContentType}\label{wxprotocolgetcontenttype} -\func{wxString }{GetContentType}{\void} +\func{wxString}{GetContentType}{\void} Returns the type of the content of the last opened stream. It is a mime-type. % ---------------------------------------------------------------------------- - -\membersection{wxProtocol::SetUser} +\membersection{wxProtocol::SetUser}\label{wxprotocolsetuser} \func{void }{SetUser}{\param{const wxString\&}{ user}} Sets the authentication user. It is mainly useful when FTP is used. -\membersection{wxProtocol::SetPassword} +\membersection{wxProtocol::SetPassword}\label{wxprotocolsetpassword} -\func{void }{SetPassword}{\param{const wxString\&}{ user}} +\func{void}{SetPassword}{\param{const wxString\&}{ user}} Sets the authentication password. It is mainly useful when FTP is used. +