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 / UpnpGetServiceVarStatus.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
3 <HTML>
4 <HEAD>
5    <TITLE>EXPORT_SPEC int UpnpGetServiceVarStatus</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">UpnpGetServiceVarStatus</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;  OUT DOMString* StVarVal )</H2><BLOCKQUOTE><B>UpnpGetServiceVarStatus</B> queries the state of a state  variable of a service on another device.</BLOCKQUOTE>
11
12 <A NAME="DOC.DOCU"></A>
13 <HR>
14 <H2>Documentation</H2>
15 <BLOCKQUOTE><B>UpnpGetServiceVarStatus</B> queries the state of a state 
16 variable of a service on another device.  This is a synchronous call.
17 A positive return value indicates a SOAP error code, whereas a negative
18 return code indicates an SDK error code. <B>Note that the use of this 
19 function is deprecated by the UPnP Forum</B>.
20
21 <P></BLOCKQUOTE>
22 <DL><DT><DT><B>Parameters:</B><DD><B>Hnd</B> -   The handle of the control point. 
23 <BR><B>ActionURL</B> -   The URL of the service. 
24 <BR><B>VarName</B> -   The name of the variable to query. 
25 <BR><B>StVarVal</B> -   The pointer to store the value 
26 for <B>VarName</B>. The SDK 
27 allocates this string and the caller 
28 needs to free it using 
29 <B>ixmlFreeDOMString</B>. <BR><DT><B>Returns:</B><DD>  [int] An integer representing one of the following:
30 <UL>
31 <LI> <TT>UPNP_E_SUCCESS</TT>: The operation completed successfully.
32 <LI> <TT>UPNP_E_INVALID_HANDLE</TT>: The handle is not a valid control 
33 point handle.
34 <LI> <TT>UPNP_E_INVALID_URL</TT>: <B>ActionUrl</B> is not a valid URL.
35 <LI> <TT>UPNP_E_INVALID_DESC</TT>: The XML document was not 
36 found or it does not contain a valid XML description.
37 <LI> <TT>UPNP_E_INVALID_PARAM</TT>: <B>StVarVal</B> is not a valid 
38 pointer or <B>VarName</B> or <B>ActionUrl</B> is <TT>NULL</TT>. 
39 <LI> <TT>UPNP_E_OUTOF_MEMORY</TT>: Insufficient resources exist to 
40 complete this operation.
41 <LI> <TT>UPNP_SOAP_E_INVALID_VAR</TT>: The given variable is invalid 
42 according to the device.
43 </UL>
44 <BR><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I></P><HR>
45 <BR>
46 This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
47 </BODY>
48 </HTML>