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 / UpnpSendActionExAsync.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
3 <HTML>
4 <HEAD>
5    <TITLE>EXPORT_SPEC int UpnpSendActionExAsync</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">UpnpSendActionExAsync</A></H2><H2>( IN <!1><A HREF="UpnpClient_Handle.html">UpnpClient_Handle</A> Hnd,<BR>&nbsp;  IN const char* ActionURL,<BR>&nbsp;  IN const char* <!1><A HREF="Upnp_Discovery.html#DOC.1.4.2.11.5">ServiceType</A>,<BR>&nbsp;  IN const char* <!1><A HREF="Upnp_State_Var_Request.html#DOC.1.4.2.8.4">DevUDN</A>,<BR>&nbsp;  IN IXML_Document* Header,<BR>&nbsp;  IN IXML_Document* Action,<BR>&nbsp;  IN Upnp_FunPtr Fun,<BR>&nbsp;  IN const void* Cookie )</H2><BLOCKQUOTE><B>UpnpSendActionExAsync</B> sends a message to change a state variable in a service, 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>UpnpSendActionExAsync</B> sends a message to change a state variable
16 in a service, generating a callback when the operation is complete.
17 See <B>UpnpSendAction</B> for comments on positive return values. These 
18 positive return values are sent in the event struct associated with the
19 <TT>UPNP_CONTROL_ACTION_COMPLETE</TT> event.
20
21 <P></BLOCKQUOTE>
22 <DL><DT><DT><B>Parameters:</B><DD><B>Hnd</B> -   The handle of the control point 
23 sending the action. 
24 <BR><B>ActionURL</B> -   The action URL of the service. 
25 <BR><B></B> - <!1><A HREF="Upnp_Discovery.html#DOC.1.4.2.11.5">ServiceType</A>  The type of the service. 
26 <BR><B></B> - <!1><A HREF="Upnp_State_Var_Request.html#DOC.1.4.2.8.4">DevUDN</A>  This parameter is ignored and must be
27 <TT>NULL</TT>. 
28 <BR><B>Header</B> -   The DOM document for the SOAP header. 
29 This may be <TT>NULL</TT> if the header is 
30 not required. 
31 <BR><B>Action</B> -   The DOM document for the action to 
32 perform on this device. 
33 <BR><B>Fun</B> -   Pointer to a callback function to 
34 be invoked when the operation 
35 completes. 
36 <BR><B>Cookie</B> -   Pointer to user data that to be 
37 passed to the callback when invoked. <BR><DT><B>Returns:</B><DD>  [int] An integer representing one of the following:
38 <UL>
39 <LI> <TT>UPNP_E_SUCCESS</TT>: The operation completed successfully.
40 <LI> <TT>UPNP_E_INVALID_HANDLE</TT>: The handle is not a valid control 
41 point handle.
42 <LI> <TT>UPNP_E_INVALID_URL</TT>: <B>ActionUrl</B> is an invalid URL.
43 <LI> <TT>UPNP_E_INVALID_DEVICE</TT>: <B>DevUDN</B> is an invalid device.
44 <LI> <TT>UPNP_E_INVALID_PARAM</TT>: Either <B>Fun</B> is not a valid 
45 callback function or <B>ServiceType</B>, <B>Act</B>, or 
46 <B>ActionUrl</B> is <TT>NULL</TT>.
47 <LI> <TT>UPNP_E_INVALID_ACTION</TT>: This action is not valid.
48 <LI> <TT>UPNP_E_OUTOF_MEMORY</TT>: Insufficient resources exist to 
49 complete this operation.
50 </UL>
51 <BR><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I></P><HR>
52 <BR>
53 This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
54 </BODY>
55 </HTML>