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

53 lines
2.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>EXPORT_SPEC int UpnpSendActionAsync</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>EXPORT_SPEC int <A HREF="#DOC.DOCU">UpnpSendActionAsync</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* Action,<BR>&nbsp; IN Upnp_FunPtr Fun,<BR>&nbsp; IN const void* Cookie )</H2><BLOCKQUOTE><B>UpnpSendActionAsync</B> sends a message to change a state variable in a service, generating a callback when the operation is complete.</BLOCKQUOTE>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE><B>UpnpSendActionAsync</B> sends a message to change a state variable
in a service, generating a callback when the operation is complete.
See <B>UpnpSendAction</B> for comments on positive return values. These
positive return values are sent in the event struct associated with the
<TT>UPNP_CONTROL_ACTION_COMPLETE</TT> event.
<P></BLOCKQUOTE>
<DL><DT><DT><B>Parameters:</B><DD><B>Hnd</B> - The handle of the control point
sending the action.
<BR><B>ActionURL</B> - The action URL of the service.
<BR><B></B> - <!1><A HREF="Upnp_Discovery.html#DOC.1.4.2.11.5">ServiceType</A> The type of the service.
<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
<TT>NULL</TT>.
<BR><B>Action</B> - The DOM document for the action to
perform on this device.
<BR><B>Fun</B> - Pointer to a callback function to
be invoked when the operation
completes.
<BR><B>Cookie</B> - Pointer to user data that to be
passed to the callback when invoked. <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_HANDLE</TT>: The handle is not a valid control
point handle.
<LI> <TT>UPNP_E_INVALID_URL</TT>: <B>ActionUrl</B> is an invalid URL.
<LI> <TT>UPNP_E_INVALID_DEVICE</TT>: <B>DevUDN</B> is an invalid device.
<LI> <TT>UPNP_E_INVALID_PARAM</TT>: Either <B>Fun</B> is not a valid
callback function or <B>ServiceType</B>, <B>Act</B>, or
<B>ActionUrl</B> is <TT>NULL</TT>.
<LI> <TT>UPNP_E_INVALID_ACTION</TT>: This action is not valid.
<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>