X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0d6957a54000dac5cdfc4440ab095d09f480dc6c..1648d51bcb7633efde873b986b4a9e2af005f119:/docs/latex/wx/http.tex diff --git a/docs/latex/wx/http.tex b/docs/latex/wx/http.tex index 1171472e75..00879c582b 100644 --- a/docs/latex/wx/http.tex +++ b/docs/latex/wx/http.tex @@ -17,16 +17,24 @@ % ---------------------------------------------------------------------------- % ---------------------------------------------------------------------------- -\membersection{wxHTTP::GetInputStream}\label{wxprotogetinput} +\membersection{wxHTTP::GetInputStream}\label{wxhttpgetinputstream} \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. +Creates a new input stream on the the specified path. You can use all except the seek +functionality of wxStream. Seek isn't available on all streams. For example, +http or ftp streams doesn't deal with it. Other functions like Tell and SeekI +for this sort of stream. 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 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. + \wxheading{Return value} Returns the initialized stream. You will have to delete it yourself once you @@ -42,14 +50,21 @@ to be reestablished: but you don't have to take care of this wxHTTP reestablishe \membersection{wxHTTP::SetHeader} -\func{void}{SetHeader}{\param{const wxString\&}{ header}, \param{const wxString\&}{ h_data}} +\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::SetHeader} +\membersection{wxHTTP::GetHeader} + \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. +