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 / UpnpNotify.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
3 <HTML>
4 <HEAD>
5    <TITLE>EXPORT_SPEC int UpnpNotify</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">UpnpNotify</A></H2><H2>( IN <!1><A HREF="UpnpDevice_Handle.html">UpnpDevice_Handle</A>,<BR>&nbsp;  IN const char* DevID,<BR>&nbsp;  IN const char* ServID,<BR>&nbsp;  IN const char** VarName,<BR>&nbsp;  IN const char** NewVal,<BR>&nbsp;  IN int cVariables )</H2><BLOCKQUOTE><B>UpnpNotify</B> sends out an event change notification to all control points subscribed to a particular service.</BLOCKQUOTE>
11
12 <A NAME="DOC.DOCU"></A>
13 <HR>
14 <H2>Documentation</H2>
15 <BLOCKQUOTE><B>UpnpNotify</B> sends out an event change notification to all
16 control points subscribed to a particular service.  This function is
17 synchronous and generates no callbacks.
18
19 <P><B>UpnpNotify</B> may be called during a callback function to send out
20 a notification.
21
22 <P></BLOCKQUOTE>
23 <DL><DT><DT><B>Parameters:</B><DD><B></B> - <!1><A HREF="UpnpDevice_Handle.html">UpnpDevice_Handle</A>  The handle to the device sending the event. 
24 <BR><B>DevID</B> -   The device ID of the subdevice of the service 
25 generating the event. 
26 <BR><B>ServID</B> -   The unique identifier of the service 
27 generating the event. 
28 <BR><B>VarName</B> -   Pointer to an array of variables that 
29 have changed. 
30 <BR><B>NewVal</B> -   Pointer to an array of new values for 
31 those variables. 
32 <BR><B>cVariables</B> -   The count of variables included in this 
33 notification. <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_HANDLE</TT>: The handle is not a valid device 
37 handle.
38 <LI> <TT>UPNP_E_INVALID_SERVICE</TT>: The <B>DevId</B>/<B>ServId</B> 
39 pair refers to an invalid service.
40 <LI> <TT>UPNP_E_INVALID_PARAM</TT>: Either <B>VarName</B>, <B>NewVal</B>, 
41 <B>DevID</B>, or <B>ServID</B> is not a valid pointer or 
42 <B>cVariables</B> is less than zero.
43 <LI> <TT>UPNP_E_OUTOF_MEMORY</TT>: Insufficient resources exist to 
44 complete this operation.
45 </UL>
46 <BR><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I></P><HR>
47 <BR>
48 This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
49 </BODY>
50 </HTML>