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

42 lines
2.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>EXPORT_SPEC int UpnpGetServiceVarStatusAsync</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>EXPORT_SPEC int <A HREF="#DOC.DOCU">UpnpGetServiceVarStatusAsync</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* VarName,<BR>&nbsp; IN Upnp_FunPtr Fun,<BR>&nbsp; IN const void* Cookie )</H2><BLOCKQUOTE><B>UpnpGetServiceVarStatusAsync</B> queries the state of a variable of a service, generating a callback when the operation is complete.</BLOCKQUOTE>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE><B>UpnpGetServiceVarStatusAsync</B> queries the state of a variable of a
service, generating a callback when the operation is complete. <B>Note
that the use of this function is deprecated by the UPnP Forum</B>.
<P></BLOCKQUOTE>
<DL><DT><DT><B>Parameters:</B><DD><B>Hnd</B> - The handle of the control point.
<BR><B>ActionURL</B> - The URL of the service.
<BR><B>VarName</B> - The name of the variable to query.
<BR><B>Fun</B> - Pointer to a callback function to
be invoked when the operation is complete.
<BR><B>Cookie</B> - Pointer to user data to pass to the
callback function 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>: The <B>ActionUrl</B> is not a valid URL.
<LI> <TT>UPNP_E_INVALID_PARAM</TT>: <B>VarName</B>, <B>Fun</B> or
<B>ActionUrl</B> is not a valid pointer.
<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>