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 / UpnpRenewSubscriptionAsync.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
3 <HTML>
4 <HEAD>
5    <TITLE>EXPORT_SPEC int UpnpRenewSubscriptionAsync</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">UpnpRenewSubscriptionAsync</A></H2><H2>( IN <!1><A HREF="UpnpClient_Handle.html">UpnpClient_Handle</A> Hnd,<BR>&nbsp;  IN int <!1><A HREF="Upnp_Event_Subscribe.html#DOC.1.4.2.12.4">TimeOut</A>,<BR>&nbsp;  IN Upnp_SID SubsId,<BR>&nbsp;  IN Upnp_FunPtr Fun,<BR>&nbsp;  IN const void* Cookie )</H2><BLOCKQUOTE><B>UpnpRenewSubscriptionAsync</B> renews a subscription that is about to expire, generating a callback when the operation is complete.</BLOCKQUOTE>
11
12 <A NAME="DOC.DOCU"></A>
13 <HR>
14 <H2>Documentation</H2>
15 <BLOCKQUOTE><B>UpnpRenewSubscriptionAsync</B> renews a subscription that is about
16 to expire, generating a callback when the operation is complete.
17
18 <P>Note that many of the error codes for this function are returned in
19 the <B>Upnp_Event_Subscribe</B> structure.  In those cases, the function
20 returns <TT>UPNP_E_SUCCESS</TT> and the appropriate error code will
21 be in the <B>Upnp_Event_Subscribe.ErrCode</B> field in the <B>Event</B>
22 structure passed to the callback.
23
24 <P></BLOCKQUOTE>
25 <DL><DT><DT><B>Parameters:</B><DD><B>Hnd</B> -   The handle of the control point that 
26 is renewing the subscription. 
27 <BR><B></B> - <!1><A HREF="Upnp_Event_Subscribe.html#DOC.1.4.2.12.4">TimeOut</A>  The requested subscription time.  The 
28 actual timeout value is returned when 
29 the callback function is called. 
30 <BR><B>SubsId</B> -   The ID for the subscription to renew. 
31 <BR><B>Fun</B> -   Pointer to a callback function to be 
32 invoked when the renewal is complete. 
33 <BR><B>Cookie</B> -   Pointer to user data passed 
34 to the callback function when invoked. <BR><DT><B>Returns:</B><DD>  [int] An integer representing one of the following:
35 <UL>
36 <LI> <TT>UPNP_E_SUCCESS</TT>: The operation completed successfully.
37 <LI> <TT>UPNP_E_INVALID_HANDLE</TT>: The handle is not a valid control 
38 point handle.
39 <LI> <TT>UPNP_E_INVALID_SID</TT>: The <B>SubsId</B> is not a valid 
40 subscription ID.
41 <LI> <TT>UPNP_E_INVALID_PARAM</TT>: Either <B>Fun</B> is not a valid 
42 callback function pointer or <B>Timeout</B> is less than zero 
43 but is not <TT>UPNP_INFINITE</TT>.
44 <LI> <TT>UPNP_E_OUTOF_MEMORY</TT>: Insufficient resources exist to 
45 complete this operation.
46 <LI> <TT>UPNP_E_NETWORK_ERROR</TT>: A network error occured (returned in 
47 the <B>Upnp_Event_Subscribe.ErrCode</B> field as part of the 
48 callback).
49 <LI> <TT>UPNP_E_SOCKET_WRITE</TT>: An error or timeout occurred writing 
50 to a socket (returned in the <B>Upnp_Event_Subscribe.ErrCode</B> 
51 field as part of the callback).
52 <LI> <TT>UPNP_E_SOCKET_READ</TT>: An error or timeout occurred reading  
53 from a socket (returned in the 
54 <B>Upnp_Event_Subscribe.ErrCode</B> field as part of the 
55 callback).
56 <LI> <TT>UPNP_E_SOCKET_BIND</TT>: An error occurred binding the socket 
57 (returned in the <B>Upnp_Event_Subscribe.ErrCode</B> field as 
58 part of the callback).
59 <LI> <TT>UPNP_E_SOCKET_CONNECT</TT>: An error occurred connecting to 
60 <B>PublisherUrl</B> (returned in the <B>
61 Upnp_Event_Subscribe.ErrCode</B> field as part of the callback).
62 <LI> <TT>UPNP_E_OUTOF_SOCKET</TT>: An error occurred creating socket (
63 returned in the <B>Upnp_Event_Subscribe.ErrCode</B> field as 
64 part of the callback).
65 <LI> <TT>UPNP_E_BAD_RESPONSE</TT>: An error occurred in response from 
66 the publisher (returned in the <B>
67 Upnp_Event_Subscribe.ErrCode</B> field as part of the callback).
68 <LI> <TT>UPNP_E_SUBSCRIBE_UNACCEPTED</TT>: The publisher refused 
69 the subscription request (returned in the <B>
70 Upnp_Event_Subscribe.ErrCode</B> field as part of the callback).
71 </UL>
72 <BR><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I></P><HR>
73 <BR>
74 This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
75 </BODY>
76 </HTML>