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 / UpnpAddToAction.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
3 <HTML>
4 <HEAD>
5    <TITLE>EXPORT_SPEC int UpnpAddToAction</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">UpnpAddToAction</A></H2><H2>( IN OUT IXML_Document**  ActionDoc,<BR>&nbsp;  IN const char*  <!1><A HREF="Upnp_Action_Request.html#DOC.1.4.2.7.4">ActionName</A>,<BR>&nbsp;  IN const char*  ServType,<BR>&nbsp;  IN const char*  ArgName,<BR>&nbsp;  IN const char*  ArgVal )</H2><BLOCKQUOTE><B>UpnpAddToAction</B> creates an action request packet based on its input  parameters (status variable name and value pair).</BLOCKQUOTE>
11
12 <A NAME="DOC.DOCU"></A>
13 <HR>
14 <H2>Documentation</H2>
15 <BLOCKQUOTE><B>UpnpAddToAction</B> creates an action request packet based on its input 
16 parameters (status variable name and value pair). This API is specially 
17 suitable inside a loop to add any number input parameters into an existing
18 action. If no action document exists in the beginning then a 
19 <B>Upnp_Document</B> variable initialized with <TT>NULL</TT> should be passed 
20 as a parameter.
21
22 <P></BLOCKQUOTE>
23 <DL><DT><DT><B>Parameters:</B><DD><B>ActionDoc</B> -   A pointer to store the action 
24 document node. 
25 <BR><B></B> - <!1><A HREF="Upnp_Action_Request.html#DOC.1.4.2.7.4">ActionName</A>  The action name. 
26 <BR><B>ServType</B> -   The service type.  
27 <BR><B>ArgName</B> -   The status variable name. 
28 <BR><B>ArgVal</B> -   The status variable value.  <BR><DT><B>Returns:</B><DD>  [int] An integer representing one of the following:
29 <UL>
30 <LI> <TT>UPNP_E_SUCCESS</TT>: The operation completed successfully.
31 <LI> <TT>UPNP_E_INVALID_PARAM</TT>: One or more of the parameters 
32 are invalid.
33 <LI> <TT>UPNP_E_OUTOF_MEMORY</TT>: Insufficient resources exist to 
34 complete this operation.
35 </UL>
36 <BR><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I></P><HR>
37 <BR>
38 This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
39 </BODY>
40 </HTML>