X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/39b91ecabeb35ad879412df1bcd1cec9ea97a20a..4179da8a81ee3110e2a8b5615e1a4f8c8b75a16b:/docs/latex/wx/http.tex?ds=sidebyside diff --git a/docs/latex/wx/http.tex b/docs/latex/wx/http.tex index 1bce1b9522..642d697fce 100644 --- a/docs/latex/wx/http.tex +++ b/docs/latex/wx/http.tex @@ -17,6 +17,14 @@ % ---------------------------------------------------------------------------- % ---------------------------------------------------------------------------- +\membersection{wxHTTP::GetResponse}\label{wxhttpgetresponse} + +\constfunc{int}{GetResponse}{\void} + +Returns the HTTP response code returned by the server. Please refer to the RFC +2616 for the list of the responses. + + \membersection{wxHTTP::GetInputStream}\label{wxhttpgetinputstream} \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}} @@ -30,7 +38,7 @@ You will be notified when the EOF is reached by an error. \wxheading{Note} You can know the size of the file you are getting using \helpref{wxStreamBase::GetSize()}{wxstreambasegetsize}. -But there is a limitation: as HTTP servers aren't obliged to pass the size ofi +But there is a limitation: as HTTP servers aren't obliged to pass the size of the file, in some case, you will be returned 0xfffffff by GetSize(). In these cases, you should use the value returned by \helpref{wxInputStream::LastRead()}{wxinputstreamlastread}: this value will be 0 when the stream is finished. @@ -48,22 +56,23 @@ to be reestablished: but you don't have to take care of this wxHTTP reestablishe % ---------------------------------------------------------------------------- -\membersection{wxHTTP::SetHeader} +\membersection{wxHTTP::SetHeader}\label{wxhttpsetheader} \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}. +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::GetHeader} +\membersection{wxHTTP::GetHeader}\label{wxhttpgetheader} \func{wxString}{GetHeader}{\param{const wxString\&}{ header}} -Returns the data attached with a field whose name is specified by \it{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. \wxheading{Note} The header is not case-sensitive: I mean that "CONTENT-TYPE" and "content-type" represent the same header. +