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

56 lines
2.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>EXPORT_SPEC int UpnpSubscribe</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>EXPORT_SPEC int <A HREF="#DOC.DOCU">UpnpSubscribe</A></H2><H2>( IN <!1><A HREF="UpnpClient_Handle.html">UpnpClient_Handle</A> Hnd,<BR>&nbsp; IN const char* <!1><A HREF="Upnp_Event_Subscribe.html#DOC.1.4.2.12.3">PublisherUrl</A>,<BR>&nbsp; INOUT int* <!1><A HREF="Upnp_Event_Subscribe.html#DOC.1.4.2.12.4">TimeOut</A>,<BR>&nbsp; OUT Upnp_SID SubsId )</H2><BLOCKQUOTE><B>UpnpSubscribe</B> registers a control point to receive event notifications from another device.</BLOCKQUOTE>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE><B>UpnpSubscribe</B> registers a control point to receive event
notifications from another device. This operation is synchronous.
<P></BLOCKQUOTE>
<DL><DT><DT><B>Parameters:</B><DD><B>Hnd</B> - The handle of the control point.
<BR><B></B> - <!1><A HREF="Upnp_Event_Subscribe.html#DOC.1.4.2.12.3">PublisherUrl</A> The URL of the service to subscribe to.
<BR><B></B> - <!1><A HREF="Upnp_Event_Subscribe.html#DOC.1.4.2.12.4">TimeOut</A> Pointer to a variable containing
the requested subscription time. Upon
return, it contains the actual
subscription time returned from the
service.
<BR><B>SubsId</B> - Pointer to a variable to receive the
subscription ID (SID). <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_HANDLE</TT>: The handle is not a valid control
point handle.
<LI> <TT>UPNP_E_INVALID_URL</TT>: <B>PublisherUrl</B> is not a valid URL.
<LI> <TT>UPNP_E_INVALID_PARAM</TT>: <B>Timeout</B> is not a valid pointer
or <B>SubsId</B> or <B>PublisherUrl</B> is <TT>NULL</TT>.
<LI> <TT>UPNP_E_NETWORK_ERROR</TT>: A network error occured.
<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 to
<B>PublisherUrl</B>.
<LI> <TT>UPNP_E_OUTOF_SOCKET</TT>: An error occurred creating a socket.
<LI> <TT>UPNP_E_BAD_RESPONSE</TT>: An error occurred in response from
the publisher.
<LI> <TT>UPNP_E_SUBSCRIBE_UNACCEPTED</TT>: The publisher refused
the subscription request.
<LI> <TT>UPNP_E_OUTOF_MEMORY</TT>: Insufficient resources exist to
complete this operation.
</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>