From: Guilhem Lavaux <lavaux@easynet.fr>
Date: Fri, 26 Feb 1999 18:51:51 +0000 (+0000)
Subject: * Missing doc file.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/0d6957a54000dac5cdfc4440ab095d09f480dc6c?ds=sidebyside

* Missing doc file.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1802 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/latex/wx/http.tex b/docs/latex/wx/http.tex
new file mode 100644
index 0000000000..1171472e75
--- /dev/null
+++ b/docs/latex/wx/http.tex
@@ -0,0 +1,55 @@
+\section{\class{wxHTTP}}\label{wxhttp}
+
+\wxheading{Derived from}
+
+\helpref{wxProtocol}{wxprotocol}
+
+\wxheading{Include files}
+
+<wx/protocol/http.h>
+
+\wxheading{See also}
+
+\helpref{wxSocketBase}{wxsocketbase}, \helpref{wxURL}{wxurl}
+
+% ----------------------------------------------------------------------------
+% Members
+% ----------------------------------------------------------------------------
+
+% ----------------------------------------------------------------------------
+\membersection{wxHTTP::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. 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 once you
+don't use it anymore. The destructor closes the network connection.
+The next time you will try to get a file the network connection will have
+to be reestablished: but you don't have to take care of this wxHTTP reestablishes it automatically.
+
+\wxheading{See also}
+
+\helpref{wxInputStream}{wxinputstream}
+
+% ----------------------------------------------------------------------------
+
+\membersection{wxHTTP::SetHeader}
+
+\func{void}{SetHeader}{\param{const wxString\&}{ header}, \param{const wxString\&}{ h_data}}
+
+It sets data of a field to be sent during the next request to the HTTP server. The field
+name is specified by \it{header} and the content by \it{h_data}.
+This is a low level function and it assumes that you know what you are doing.
+
+\membersection{wxHTTP::SetHeader}
+\func{wxString}{GetHeader}{\param{const wxString\&}{ header}}
+
+Returns the data attached with a field whose name is specified by \it{header}.
+If the field doesn't exist, it will return an empty string and not a NULL string.