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 / Upnp_State_Var_Request.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
3 <HTML>
4 <HEAD>
5    <TITLE>struct  Upnp_State_Var_Request</TITLE>
6    <META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
7 </HEAD>
8 <BODY BGCOLOR="#ffffff">
9
10 <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>
11
12 <HR>
13 <P><DL>
14  <DT>
15 <IMG ALT="[more]" BORDER=0 SRC=icon1.gif>struct  in_addr <B><A HREF="#DOC.1.4.2.8.7">CtrlPtIPAddr</A></B>
16 <DD><I>IP address of sender requesting the state variable.</I>
17 <DT>
18 <IMG ALT="[more]" BORDER=0 SRC=icon1.gif>DOMString <B><A HREF="#DOC.1.4.2.8.8">CurrentVal</A></B>
19 <DD><I>The current value of the variable.</I>
20 <DT>
21 <IMG ALT="[more]" BORDER=0 SRC=icon1.gif>char <B><A HREF="#DOC.1.4.2.8.4">DevUDN</A></B>[NAME_SIZE]
22 <DD><I>The unique device ID.</I>
23 <DT>
24 <IMG ALT="[more]" BORDER=0 SRC=icon1.gif>int <B><A HREF="#DOC.1.4.2.8.1">ErrCode</A></B>
25 <DD><I>The result of the operation.</I>
26 <DT>
27 <IMG ALT="[more]" BORDER=0 SRC=icon1.gif>char <B><A HREF="#DOC.1.4.2.8.3">ErrStr</A></B>[LINE_SIZE]
28 <DD><I>The error string in case of error.</I>
29 <DT>
30 <IMG ALT="[more]" BORDER=0 SRC=icon1.gif>char <B><A HREF="#DOC.1.4.2.8.5">ServiceID</A></B>[NAME_SIZE]
31 <DD><I>The  service ID.</I>
32 <DT>
33 <IMG ALT="[more]" BORDER=0 SRC=icon1.gif>int <B><A HREF="#DOC.1.4.2.8.2">Socket</A></B>
34 <DD><I>The socket number of the connection to the requestor.</I>
35 <DT>
36 <IMG ALT="[more]" BORDER=0 SRC=icon1.gif>char <B><A HREF="#DOC.1.4.2.8.6">StateVarName</A></B>[NAME_SIZE]
37 <DD><I>The name of the variable.</I>
38 </DL></P>
39
40
41 <A NAME="DOC.DOCU"></A>
42 <HR>
43 <H2>Documentation</H2>
44 <BLOCKQUOTE>Represents the request for current value of a state variable in a service
45 state table.  </BLOCKQUOTE>
46 <DL>
47
48 <A NAME="ErrCode"></A>
49 <A NAME="DOC.1.4.2.8.1"></A>
50 <DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>int ErrCode</B></TT>
51 <DD>The result of the operation. 
52 <DL><DT><DD></DL><P>
53 <A NAME="Socket"></A>
54 <A NAME="DOC.1.4.2.8.2"></A>
55 <DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>int Socket</B></TT>
56 <DD>The socket number of the connection to the requestor. 
57 <DL><DT><DD></DL><P>
58 <A NAME="ErrStr"></A>
59 <A NAME="DOC.1.4.2.8.3"></A>
60 <DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>char ErrStr[LINE_SIZE]</B></TT>
61 <DD>The error string in case of error. 
62 <DL><DT><DD></DL><P>
63 <A NAME="DevUDN"></A>
64 <A NAME="DOC.1.4.2.8.4"></A>
65 <DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>char DevUDN[NAME_SIZE]</B></TT>
66 <DD>The unique device ID. 
67 <DL><DT><DD></DL><P>
68 <A NAME="ServiceID"></A>
69 <A NAME="DOC.1.4.2.8.5"></A>
70 <DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>char ServiceID[NAME_SIZE]</B></TT>
71 <DD>The  service ID. 
72 <DL><DT><DD></DL><P>
73 <A NAME="StateVarName"></A>
74 <A NAME="DOC.1.4.2.8.6"></A>
75 <DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>char StateVarName[NAME_SIZE]</B></TT>
76 <DD>The name of the variable. 
77 <DL><DT><DD></DL><P>
78 <A NAME="CtrlPtIPAddr"></A>
79 <A NAME="DOC.1.4.2.8.7"></A>
80 <DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>struct  in_addr CtrlPtIPAddr</B></TT>
81 <DD>IP address of sender requesting the state variable. 
82 <DL><DT><DD></DL><P>
83 <A NAME="CurrentVal"></A>
84 <A NAME="DOC.1.4.2.8.8"></A>
85 <DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>DOMString CurrentVal</B></TT>
86 <DD>The current value of the variable. This needs to be allocated by 
87 the caller.  When finished with it, the SDK frees this <B>DOMString</B>. 
88 <DL><DT><DD></DL><P></DL>
89 <DL><DT><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I></P><HR>
90 <BR>
91 This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
92 </BODY>
93 </HTML>