projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 0d6957a5 GL |
1 | \section{\class{wxHTTP}}\label{wxhttp} |
| 2 | ||
| 3 | \wxheading{Derived from} | |
| 4 | ||
| 5 | \helpref{wxProtocol}{wxprotocol} | |
| 6 | ||
| 7 | \wxheading{Include files} | |
| 8 | ||
| 9 | <wx/protocol/http.h> | |
| 10 | ||
| 11 | \wxheading{See also} | |
| 12 | ||
| 13 | \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxURL}{wxurl} | |
| 14 | ||
| 15 | % ---------------------------------------------------------------------------- | |
| 16 | % Members | |
| 17 | % ---------------------------------------------------------------------------- | |
| 18 | ||
| 19 | % ---------------------------------------------------------------------------- | |
| 721b32e0 | 20 | \membersection{wxHTTP::GetInputStream}\label{wxhttpgetinputstream} |
| 0d6957a5 GL |
21 | |
| 22 | \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}} | |
| 23 | ||
| 721b32e0 JS |
24 | Creates a new input stream on the the specified path. You can use all except the seek |
| 25 | functionality of wxStream. Seek isn't available on all streams. For example, | |
| 0d6957a5 GL |
26 | http or ftp streams doesn't deal with it. Other functions like StreamSize and |
| 27 | Tell aren't available for the moment for this sort of stream. | |
| 28 | You will be notified when the EOF is reached by an error. | |
| 29 | ||
| 30 | \wxheading{Return value} | |
| 31 | ||
| 32 | Returns the initialized stream. You will have to delete it yourself once you | |
| 33 | don't use it anymore. The destructor closes the network connection. | |
| 34 | The next time you will try to get a file the network connection will have | |
| 35 | to be reestablished: but you don't have to take care of this wxHTTP reestablishes it automatically. | |
| 36 | ||
| 37 | \wxheading{See also} | |
| 38 | ||
| 39 | \helpref{wxInputStream}{wxinputstream} | |
| 40 | ||
| 41 | % ---------------------------------------------------------------------------- | |
| 42 | ||
| 43 | \membersection{wxHTTP::SetHeader} | |
| 44 | ||
| 294e9a7a | 45 | \func{void}{SetHeader}{\param{const wxString\&}{ header}, \param{const wxString\&}{ h\_data}} |
| 0d6957a5 GL |
46 | |
| 47 | It sets data of a field to be sent during the next request to the HTTP server. The field | |
| 294e9a7a | 48 | name is specified by \it{header} and the content by \it{h\_data}. |
| 0d6957a5 GL |
49 | This is a low level function and it assumes that you know what you are doing. |
| 50 | ||
| 51 | \membersection{wxHTTP::SetHeader} | |
| 721b32e0 | 52 | |
| 0d6957a5 GL |
53 | \func{wxString}{GetHeader}{\param{const wxString\&}{ header}} |
| 54 | ||
| 55 | Returns the data attached with a field whose name is specified by \it{header}. | |
| 56 | If the field doesn't exist, it will return an empty string and not a NULL string. | |
| 721b32e0 | 57 |