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 / UpnpGetServiceVarStatusAsync.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
3 <HTML>
4 <HEAD>
5    <TITLE>EXPORT_SPEC int UpnpGetServiceVarStatusAsync</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">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>
11
12 <A NAME="DOC.DOCU"></A>
13 <HR>
14 <H2>Documentation</H2>
15 <BLOCKQUOTE><B>UpnpGetServiceVarStatusAsync</B> queries the state of a variable of a 
16 service, generating a callback when the operation is complete. <B>Note 
17 that the use of this function is deprecated by the UPnP Forum</B>.
18
19 <P></BLOCKQUOTE>
20 <DL><DT><DT><B>Parameters:</B><DD><B>Hnd</B> -   The handle of the control point. 
21 <BR><B>ActionURL</B> -   The URL of the service. 
22 <BR><B>VarName</B> -   The name of the variable to query. 
23 <BR><B>Fun</B> -   Pointer to a callback function to 
24 be invoked when the operation is complete. 
25 <BR><B>Cookie</B> -   Pointer to user data to pass to the 
26 callback function when invoked. <BR><DT><B>Returns:</B><DD>  [int] An integer representing one of the following:
27 <UL>
28 <LI> <TT>UPNP_E_SUCCESS</TT>: The operation completed successfully.
29 <LI> <TT>UPNP_E_INVALID_HANDLE</TT>: The handle is not a valid control 
30 point handle.
31 <LI> <TT>UPNP_E_INVALID_URL</TT>: The <B>ActionUrl</B> is not a valid URL.
32 <LI> <TT>UPNP_E_INVALID_PARAM</TT>: <B>VarName</B>, <B>Fun</B> or 
33 <B>ActionUrl</B> is not a valid pointer.
34 <LI> <TT>UPNP_E_OUTOF_MEMORY</TT>: Insufficient resources exist to 
35 complete this operation.
36 </UL>
37 <BR><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I></P><HR>
38 <BR>
39 This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
40 </BODY>
41 </HTML>