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

41 lines
2.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>EXPORT_SPEC int UpnpAddToAction</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
</HEAD>
<BODY BGCOLOR="#ffffff">
<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>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE><B>UpnpAddToAction</B> creates an action request packet based on its input
parameters (status variable name and value pair). This API is specially
suitable inside a loop to add any number input parameters into an existing
action. If no action document exists in the beginning then a
<B>Upnp_Document</B> variable initialized with <TT>NULL</TT> should be passed
as a parameter.
<P></BLOCKQUOTE>
<DL><DT><DT><B>Parameters:</B><DD><B>ActionDoc</B> - A pointer to store the action
document node.
<BR><B></B> - <!1><A HREF="Upnp_Action_Request.html#DOC.1.4.2.7.4">ActionName</A> The action name.
<BR><B>ServType</B> - The service type.
<BR><B>ArgName</B> - The status variable name.
<BR><B>ArgVal</B> - The status variable value. <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_PARAM</TT>: One or more of the parameters
are invalid.
<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>