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 / UpnpOpenHttpGetEx.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
3 <HTML>
4 <HEAD>
5    <TITLE>EXPORT_SPEC int UpnpOpenHttpGetEx</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">UpnpOpenHttpGetEx</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 lowRange,<BR>&nbsp;  IN int highRange,<BR>&nbsp;  IN int timeout )</H2><BLOCKQUOTE><B>UpnpOpenHttpGetEx</B> gets specified number of bytes from a file  specified in the URL.</BLOCKQUOTE>
11
12 <A NAME="DOC.DOCU"></A>
13 <HR>
14 <H2>Documentation</H2>
15 <BLOCKQUOTE><B>UpnpOpenHttpGetEx</B> gets specified number of bytes from a file 
16 specified in the URL. The number of bytes is specified through a low 
17 count and a high count which are passed as a range of bytes for the 
18 request.  The SDK allocates the memory for <B>handle</B> and 
19 <B>contentType</B>, the application is responsible for freeing this memory.
20
21 <P></BLOCKQUOTE>
22 <DL><DT><DT><B>Parameters:</B><DD><B>url</B> -   The URL of the item to get. 
23 <BR><B>handle</B> -   A pointer to store the handle for 
24 this connection. 
25 <BR><B>contentType</B> -   A buffer to store the media type of the 
26 item. 
27 <BR><B>contentLength</B> -   A buffer to store the length of the 
28 item. 
29 <BR><B>httpStatus</B> -   The status returned on receiving a 
30 response message from the remote 
31 server. 
32 <BR><B>lowRange</B> -   An integer value representing the low 
33 end of a range to retrieve. 
34 <BR><B>highRange</B> -   An integer value representing the high 
35 end of a range to retrieve. 
36 <BR><B>timeout</B> -   A time out value sent with the request 
37 during which a response is expected 
38 from the server, failing which, an 
39 error is reported back to the user. <BR><DT><B>Returns:</B><DD>  [int] An integer representing one of the following:
40 <UL>
41 <LI> <TT>UPNP_E_SUCCESS</TT>: The operation completed successfully.
42 <LI> <TT>UPNP_E_INVALID_PARAM</TT>: Either <B>url</B>, <B>handle</B>,  
43 <B>contentType</B>, <B>contentLength</B> or <B>httpStatus</B> 
44 is not a valid pointer.
45 <LI> <TT>UPNP_E_INVALID_URL</TT>: The <B>url</B> is not a valid 
46 URL.
47 <LI> <TT>UPNP_E_OUTOF_MEMORY</TT>: Insufficient resources exist to 
48 download this file.
49 <LI> <TT>UPNP_E_NETWORK_ERROR</TT>: A network error occurred.
50 <LI> <TT>UPNP_E_SOCKET_WRITE</TT>: An error or timeout occurred writing 
51 to a socket.
52 <LI> <TT>UPNP_E_SOCKET_READ</TT>: An error or timeout occurred reading 
53 from a socket.
54 <LI> <TT>UPNP_E_SOCKET_BIND</TT>: An error occurred binding a socket.
55 <LI> <TT>UPNP_E_SOCKET_CONNECT</TT>: An error occurred connecting a 
56 socket.
57 <LI> <TT>UPNP_E_OUTOF_SOCKET</TT>: Too many sockets are currently 
58 allocated.
59 <LI> <TT>UPNP_E_BAD_RESPONSE</TT>: A bad response was received from the 
60 remote server.
61 </UL>
62 <BR><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I></P><HR>
63 <BR>
64 This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
65 </BODY>
66 </HTML>