pupnp (libupnp) snapshot from SourceForge: git clone git://pupnp.git.sourceforge...
[igd2-for-linux:pandonghui1211s-igd2-for-linux.git] / pupnp_branch-1.6.x / docs / dist / html / upnp / UpnpOpenHttpGet.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
3 <HTML>
4 <HEAD>
5    <TITLE>EXPORT_SPEC int UpnpOpenHttpGet</TITLE>
6    <META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
7 </HEAD>
8 <BODY BGCOLOR="#ffffff">
9
10 <H2>EXPORT_SPEC int <A HREF="#DOC.DOCU">UpnpOpenHttpGet</A></H2><H2>( IN const char* url,<BR>&nbsp;  IN OUT void** handle,<BR>&nbsp;  IN OUT char** contentType,<BR>&nbsp;  IN OUT int* contentLength,<BR>&nbsp;  IN OUT int* httpStatus,<BR>&nbsp;  IN int timeout )</H2><BLOCKQUOTE><B>UpnpOpenHttpGet</B> gets a file specified in a URL.</BLOCKQUOTE>
11
12 <A NAME="DOC.DOCU"></A>
13 <HR>
14 <H2>Documentation</H2>
15 <BLOCKQUOTE><B>UpnpOpenHttpGet</B> gets a file specified in a URL.
16 The SDK allocates the memory for <B>handle</B> and 
17 <B>contentType</B>, the application is responsible for freeing this memory.
18
19 <P></BLOCKQUOTE>
20 <DL><DT><DT><B>Parameters:</B><DD><B>url</B> -   The URL of an item to get. 
21 <BR><B>handle</B> -   A pointer to store the handle for 
22 this connection. 
23 <BR><B>contentType</B> -   A buffer to store the media type of 
24 the item. 
25 <BR><B>contentLength</B> -   A pointer to store the length of the 
26 item. 
27 <BR><B>httpStatus</B> -   The status returned on receiving a 
28 response message. 
29 <BR><B>timeout</B> -   The time out value sent with the 
30 request during which a response is 
31 expected from the server, failing 
32 which, an error is reported back to 
33 the user. <BR><DT><B>Returns:</B><DD>  [int] An integer representing one of the following:
34 <UL>
35 <LI> <TT>UPNP_E_SUCCESS</TT>: The operation completed successfully.
36 <LI> <TT>UPNP_E_INVALID_PARAM</TT>: Either <B>url</B>, <B>handle</B>,  
37 <B>contentType</B>, <B>contentLength</B> or <B>httpStatus</B> 
38 is not a valid pointer.
39 <LI> <TT>UPNP_E_INVALID_URL</TT>: The <B>url</B> is not a valid 
40 URL.
41 <LI> <TT>UPNP_E_OUTOF_MEMORY</TT>: Insufficient resources exist to 
42 download this file.
43 <LI> <TT>UPNP_E_NETWORK_ERROR</TT>: A network error occurred.
44 <LI> <TT>UPNP_E_SOCKET_WRITE</TT>: An error or timeout occurred writing 
45 to a socket.
46 <LI> <TT>UPNP_E_SOCKET_READ</TT>: An error or timeout occurred reading 
47 from a socket.
48 <LI> <TT>UPNP_E_SOCKET_BIND</TT>: An error occurred binding a socket.
49 <LI> <TT>UPNP_E_SOCKET_CONNECT</TT>: An error occurred connecting a 
50 socket.
51 <LI> <TT>UPNP_E_OUTOF_SOCKET</TT>: Too many sockets are currently 
52 allocated.
53 <LI> <TT>UPNP_E_BAD_RESPONSE</TT>: A bad response was received from the 
54 remote server.
55 </UL>
56 <BR><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I></P><HR>
57 <BR>
58 This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
59 </BODY>
60 </HTML>