ebac5fe596
git-svn-id: https://pupnp.svn.sourceforge.net/svnroot/pupnp/trunk@45 119443c7-1b9e-41f8-b6fc-b9c35fce742c
49 lines
2.3 KiB
HTML
49 lines
2.3 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
|
|
<HTML>
|
|
<HEAD>
|
|
<TITLE>EXPORT_SPEC int UpnpGetServiceVarStatus</TITLE>
|
|
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
|
|
</HEAD>
|
|
<BODY BGCOLOR="#ffffff">
|
|
|
|
<H2>EXPORT_SPEC int <A HREF="#DOC.DOCU">UpnpGetServiceVarStatus</A></H2><H2>( IN <!1><A HREF="UpnpClient_Handle.html">UpnpClient_Handle</A> Hnd,<BR> IN const char* ActionURL,<BR> IN const char* VarName,<BR> OUT DOMString* StVarVal )</H2><BLOCKQUOTE><B>UpnpGetServiceVarStatus</B> queries the state of a state variable of a service on another device.</BLOCKQUOTE>
|
|
|
|
<A NAME="DOC.DOCU"></A>
|
|
<HR>
|
|
<H2>Documentation</H2>
|
|
<BLOCKQUOTE><B>UpnpGetServiceVarStatus</B> queries the state of a state
|
|
variable of a service on another device. This is a synchronous call.
|
|
A positive return value indicates a SOAP error code, whereas a negative
|
|
return code indicates an SDK error code. <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>StVarVal</B> - The pointer to store the value
|
|
for <B>VarName</B>. The SDK
|
|
allocates this string and the caller
|
|
needs to free it using
|
|
<B>ixmlFreeDOMString</B>. <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 not a valid URL.
|
|
<LI> <TT>UPNP_E_INVALID_DESC</TT>: The XML document was not
|
|
found or it does not contain a valid XML description.
|
|
<LI> <TT>UPNP_E_INVALID_PARAM</TT>: <B>StVarVal</B> is not a valid
|
|
pointer or <B>VarName</B> or <B>ActionUrl</B> is <TT>NULL</TT>.
|
|
<LI> <TT>UPNP_E_OUTOF_MEMORY</TT>: Insufficient resources exist to
|
|
complete this operation.
|
|
<LI> <TT>UPNP_SOAP_E_INVALID_VAR</TT>: The given variable is invalid
|
|
according to the device.
|
|
</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>
|