libupnp/docs/dist/html/upnp/UpnpOpenHttpGetEx.html
2006-07-06 12:37:29 +00:00

67 lines
3.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>EXPORT_SPEC int UpnpOpenHttpGetEx</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
</HEAD>
<BODY BGCOLOR="#ffffff">
<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>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE><B>UpnpOpenHttpGetEx</B> gets specified number of bytes from a file
specified in the URL. The number of bytes is specified through a low
count and a high count which are passed as a range of bytes for the
request. The SDK allocates the memory for <B>handle</B> and
<B>contentType</B>, the application is responsible for freeing this memory.
<P></BLOCKQUOTE>
<DL><DT><DT><B>Parameters:</B><DD><B>url</B> - The URL of the item to get.
<BR><B>handle</B> - A pointer to store the handle for
this connection.
<BR><B>contentType</B> - A buffer to store the media type of the
item.
<BR><B>contentLength</B> - A buffer to store the length of the
item.
<BR><B>httpStatus</B> - The status returned on receiving a
response message from the remote
server.
<BR><B>lowRange</B> - An integer value representing the low
end of a range to retrieve.
<BR><B>highRange</B> - An integer value representing the high
end of a range to retrieve.
<BR><B>timeout</B> - A time out value sent with the request
during which a response is expected
from the server, failing which, an
error is reported back to the user. <BR><DT><B>Returns:</B><DD> [int] An integer representing one of the following:
<UL>
<LI> <TT>UPNP_E_SUCCESS</TT>: The operation completed successfully.
<LI> <TT>UPNP_E_INVALID_PARAM</TT>: Either <B>url</B>, <B>handle</B>,
<B>contentType</B>, <B>contentLength</B> or <B>httpStatus</B>
is not a valid pointer.
<LI> <TT>UPNP_E_INVALID_URL</TT>: The <B>url</B> is not a valid
URL.
<LI> <TT>UPNP_E_OUTOF_MEMORY</TT>: Insufficient resources exist to
download this file.
<LI> <TT>UPNP_E_NETWORK_ERROR</TT>: A network error occurred.
<LI> <TT>UPNP_E_SOCKET_WRITE</TT>: An error or timeout occurred writing
to a socket.
<LI> <TT>UPNP_E_SOCKET_READ</TT>: An error or timeout occurred reading
from a socket.
<LI> <TT>UPNP_E_SOCKET_BIND</TT>: An error occurred binding a socket.
<LI> <TT>UPNP_E_SOCKET_CONNECT</TT>: An error occurred connecting a
socket.
<LI> <TT>UPNP_E_OUTOF_SOCKET</TT>: Too many sockets are currently
allocated.
<LI> <TT>UPNP_E_BAD_RESPONSE</TT>: A bad response was received from the
remote server.
</UL>
<BR><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I></P><HR>
<BR>
This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
</BODY>
</HTML>