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

94 lines
3.5 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>struct Upnp_State_Var_Request</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>struct <A HREF="#DOC.DOCU">Upnp_State_Var_Request</A></H2></H2><BLOCKQUOTE>Represents the request for current value of a state variable in a service state table.</BLOCKQUOTE>
<HR>
<P><DL>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>struct in_addr <B><A HREF="#DOC.1.4.2.8.7">CtrlPtIPAddr</A></B>
<DD><I>IP address of sender requesting the state variable.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>DOMString <B><A HREF="#DOC.1.4.2.8.8">CurrentVal</A></B>
<DD><I>The current value of the variable.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>char <B><A HREF="#DOC.1.4.2.8.4">DevUDN</A></B>[NAME_SIZE]
<DD><I>The unique device ID.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>int <B><A HREF="#DOC.1.4.2.8.1">ErrCode</A></B>
<DD><I>The result of the operation.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>char <B><A HREF="#DOC.1.4.2.8.3">ErrStr</A></B>[LINE_SIZE]
<DD><I>The error string in case of error.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>char <B><A HREF="#DOC.1.4.2.8.5">ServiceID</A></B>[NAME_SIZE]
<DD><I>The service ID.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>int <B><A HREF="#DOC.1.4.2.8.2">Socket</A></B>
<DD><I>The socket number of the connection to the requestor.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>char <B><A HREF="#DOC.1.4.2.8.6">StateVarName</A></B>[NAME_SIZE]
<DD><I>The name of the variable.</I>
</DL></P>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>Represents the request for current value of a state variable in a service
state table. </BLOCKQUOTE>
<DL>
<A NAME="ErrCode"></A>
<A NAME="DOC.1.4.2.8.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>int ErrCode</B></TT>
<DD>The result of the operation.
<DL><DT><DD></DL><P>
<A NAME="Socket"></A>
<A NAME="DOC.1.4.2.8.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>int Socket</B></TT>
<DD>The socket number of the connection to the requestor.
<DL><DT><DD></DL><P>
<A NAME="ErrStr"></A>
<A NAME="DOC.1.4.2.8.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>char ErrStr[LINE_SIZE]</B></TT>
<DD>The error string in case of error.
<DL><DT><DD></DL><P>
<A NAME="DevUDN"></A>
<A NAME="DOC.1.4.2.8.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>char DevUDN[NAME_SIZE]</B></TT>
<DD>The unique device ID.
<DL><DT><DD></DL><P>
<A NAME="ServiceID"></A>
<A NAME="DOC.1.4.2.8.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>char ServiceID[NAME_SIZE]</B></TT>
<DD>The service ID.
<DL><DT><DD></DL><P>
<A NAME="StateVarName"></A>
<A NAME="DOC.1.4.2.8.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>char StateVarName[NAME_SIZE]</B></TT>
<DD>The name of the variable.
<DL><DT><DD></DL><P>
<A NAME="CtrlPtIPAddr"></A>
<A NAME="DOC.1.4.2.8.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>struct in_addr CtrlPtIPAddr</B></TT>
<DD>IP address of sender requesting the state variable.
<DL><DT><DD></DL><P>
<A NAME="CurrentVal"></A>
<A NAME="DOC.1.4.2.8.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>DOMString CurrentVal</B></TT>
<DD>The current value of the variable. This needs to be allocated by
the caller. When finished with it, the SDK frees this <B>DOMString</B>.
<DL><DT><DD></DL><P></DL>
<DL><DT><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>