| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 5 |
<title>OobsIfaceWireless</title> |
| 6 |
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> |
| 7 |
<link rel="home" href="index.html" title="Liboobs (System configuration management) Reference Manual"> |
| 8 |
<link rel="up" href="ch06.html" title="Network interfaces management"> |
| 9 |
<link rel="prev" href="OobsIfacePPP.html" title="OobsIfacePPP"> |
| 10 |
<link rel="next" href="ch07.html" title="Hosts resolution management"> |
| 11 |
<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> |
| 12 |
<link rel="stylesheet" href="style.css" type="text/css"> |
| 13 |
</head> |
| 14 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| 15 |
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> |
| 16 |
<tr valign="middle"> |
| 17 |
<td><a accesskey="p" href="OobsIfacePPP.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> |
| 18 |
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> |
| 19 |
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> |
| 20 |
<th width="100%" align="center">Liboobs (System configuration management) Reference Manual</th> |
| 21 |
<td><a accesskey="n" href="ch07.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> |
| 22 |
</tr> |
| 23 |
<tr><td colspan="5" class="shortcuts"> |
| 24 |
<a href="#OobsIfaceWireless.synopsis" class="shortcut">Top</a> |
| 25 |
| |
| 26 |
<a href="#OobsIfaceWireless.description" class="shortcut">Description</a> |
| 27 |
| |
| 28 |
<a href="#OobsIfaceWireless.object-hierarchy" class="shortcut">Object Hierarchy</a> |
| 29 |
| |
| 30 |
<a href="#OobsIfaceWireless.properties" class="shortcut">Properties</a> |
| 31 |
</td></tr> |
| 32 |
</table> |
| 33 |
<div class="refentry" title="OobsIfaceWireless"> |
| 34 |
<a name="OobsIfaceWireless"></a><div class="titlepage"></div> |
| 35 |
<div class="refnamediv"><table width="100%"><tr> |
| 36 |
<td valign="top"> |
| 37 |
<h2><span class="refentrytitle"><a name="OobsIfaceWireless.top_of_page"></a>OobsIfaceWireless</span></h2> |
| 38 |
<p>OobsIfaceWireless — Object that represents an individual Wireless interface</p> |
| 39 |
</td> |
| 40 |
<td valign="top" align="right"></td> |
| 41 |
</tr></table></div> |
| 42 |
<div class="refsynopsisdiv" title="Synopsis"> |
| 43 |
<a name="OobsIfaceWireless.synopsis"></a><h2>Synopsis</h2> |
| 44 |
<pre class="synopsis"> <a class="link" href="OobsIfaceWireless.html#OobsIfaceWireless-struct" title="OobsIfaceWireless">OobsIfaceWireless</a>; |
| 45 |
<a class="link" href="OobsIfaceWireless.html#OobsIfaceWirelessClass" title="OobsIfaceWirelessClass">OobsIfaceWirelessClass</a>; |
| 46 |
const <span class="returnvalue">gchar</span>* <a class="link" href="OobsIfaceWireless.html#oobs-iface-wireless-get-essid" title="oobs_iface_wireless_get_essid ()">oobs_iface_wireless_get_essid</a> (<em class="parameter"><code><a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a> *iface</code></em>); |
| 47 |
<span class="returnvalue">void</span> <a class="link" href="OobsIfaceWireless.html#oobs-iface-wireless-set-essid" title="oobs_iface_wireless_set_essid ()">oobs_iface_wireless_set_essid</a> (<em class="parameter"><code><a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a> *iface</code></em>, |
| 48 |
<em class="parameter"><code>const <span class="type">gchar</span> *essid</code></em>); |
| 49 |
const <span class="returnvalue">gchar</span>* <a class="link" href="OobsIfaceWireless.html#oobs-iface-wireless-get-key" title="oobs_iface_wireless_get_key ()">oobs_iface_wireless_get_key</a> (<em class="parameter"><code><a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a> *iface</code></em>); |
| 50 |
<span class="returnvalue">void</span> <a class="link" href="OobsIfaceWireless.html#oobs-iface-wireless-set-key" title="oobs_iface_wireless_set_key ()">oobs_iface_wireless_set_key</a> (<em class="parameter"><code><a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a> *iface</code></em>, |
| 51 |
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>); |
| 52 |
const <span class="returnvalue">gchar</span>* <a class="link" href="OobsIfaceWireless.html#oobs-iface-wireless-get-key-type" title="oobs_iface_wireless_get_key_type ()">oobs_iface_wireless_get_key_type</a> (<em class="parameter"><code><a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a> *iface</code></em>); |
| 53 |
<span class="returnvalue">void</span> <a class="link" href="OobsIfaceWireless.html#oobs-iface-wireless-set-key-type" title="oobs_iface_wireless_set_key_type ()">oobs_iface_wireless_set_key_type</a> (<em class="parameter"><code><a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a> *iface</code></em>, |
| 54 |
<em class="parameter"><code>const <span class="type">gchar</span> *key_type</code></em>); |
| 55 |
</pre> |
| 56 |
</div> |
| 57 |
<div class="refsect1" title="Object Hierarchy"> |
| 58 |
<a name="OobsIfaceWireless.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| 59 |
<pre class="synopsis"> |
| 60 |
GObject |
| 61 |
+----<a class="link" href="liboobs-Oobs.html#OobsIface">OobsIface</a> |
| 62 |
+----<a class="link" href="OobsIfaceEthernet.html" title="OobsIfaceEthernet">OobsIfaceEthernet</a> |
| 63 |
+----OobsIfaceWireless |
| 64 |
</pre> |
| 65 |
</div> |
| 66 |
<div class="refsect1" title="Properties"> |
| 67 |
<a name="OobsIfaceWireless.properties"></a><h2>Properties</h2> |
| 68 |
<pre class="synopsis"> |
| 69 |
"<a class="link" href="OobsIfaceWireless.html#OobsIfaceWireless--essid" title='The "essid" property'>essid</a>" <span class="type">gchar</span>* : Read / Write |
| 70 |
"<a class="link" href="OobsIfaceWireless.html#OobsIfaceWireless--key" title='The "key" property'>key</a>" <span class="type">gchar</span>* : Read / Write |
| 71 |
"<a class="link" href="OobsIfaceWireless.html#OobsIfaceWireless--key-type" title='The "key-type" property'>key-type</a>" <span class="type">gchar</span>* : Read / Write |
| 72 |
</pre> |
| 73 |
</div> |
| 74 |
<div class="refsect1" title="Description"> |
| 75 |
<a name="OobsIfaceWireless.description"></a><h2>Description</h2> |
| 76 |
</div> |
| 77 |
<div class="refsect1" title="Details"> |
| 78 |
<a name="OobsIfaceWireless.details"></a><h2>Details</h2> |
| 79 |
<div class="refsect2" title="OobsIfaceWireless"> |
| 80 |
<a name="OobsIfaceWireless-struct"></a><h3>OobsIfaceWireless</h3> |
| 81 |
<pre class="programlisting">typedef struct _OobsIfaceWireless OobsIfaceWireless;</pre> |
| 82 |
<p> |
| 83 |
</p> |
| 84 |
</div> |
| 85 |
<hr> |
| 86 |
<div class="refsect2" title="OobsIfaceWirelessClass"> |
| 87 |
<a name="OobsIfaceWirelessClass"></a><h3>OobsIfaceWirelessClass</h3> |
| 88 |
<pre class="programlisting">typedef struct { |
| 89 |
OobsIfaceEthernetClass parent_class; |
| 90 |
|
| 91 |
void (*_oobs_padding1) (void); |
| 92 |
void (*_oobs_padding2) (void); |
| 93 |
} OobsIfaceWirelessClass; |
| 94 |
</pre> |
| 95 |
<p> |
| 96 |
</p> |
| 97 |
</div> |
| 98 |
<hr> |
| 99 |
<div class="refsect2" title="oobs_iface_wireless_get_essid ()"> |
| 100 |
<a name="oobs-iface-wireless-get-essid"></a><h3>oobs_iface_wireless_get_essid ()</h3> |
| 101 |
<pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_iface_wireless_get_essid (<em class="parameter"><code><a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a> *iface</code></em>);</pre> |
| 102 |
<p> |
| 103 |
Returns the network identification (ESSID) that this interface uses. |
| 104 |
</p> |
| 105 |
<div class="variablelist"><table border="0"> |
| 106 |
<col align="left" valign="top"> |
| 107 |
<tbody> |
| 108 |
<tr> |
| 109 |
<td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td> |
| 110 |
<td>an <a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a>. |
| 111 |
</td> |
| 112 |
</tr> |
| 113 |
<tr> |
| 114 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 115 |
<td> A pointer to the network identification as a string. This |
| 116 |
string must not be freed, modified or stored. |
| 117 |
</td> |
| 118 |
</tr> |
| 119 |
</tbody> |
| 120 |
</table></div> |
| 121 |
</div> |
| 122 |
<hr> |
| 123 |
<div class="refsect2" title="oobs_iface_wireless_set_essid ()"> |
| 124 |
<a name="oobs-iface-wireless-set-essid"></a><h3>oobs_iface_wireless_set_essid ()</h3> |
| 125 |
<pre class="programlisting"><span class="returnvalue">void</span> oobs_iface_wireless_set_essid (<em class="parameter"><code><a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a> *iface</code></em>, |
| 126 |
<em class="parameter"><code>const <span class="type">gchar</span> *essid</code></em>);</pre> |
| 127 |
<p> |
| 128 |
Sets a new network identification (ESSID), |
| 129 |
overwriting the previous one. |
| 130 |
</p> |
| 131 |
<div class="variablelist"><table border="0"> |
| 132 |
<col align="left" valign="top"> |
| 133 |
<tbody> |
| 134 |
<tr> |
| 135 |
<td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td> |
| 136 |
<td>An <a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a>. |
| 137 |
</td> |
| 138 |
</tr> |
| 139 |
<tr> |
| 140 |
<td><p><span class="term"><em class="parameter"><code>essid</code></em> :</span></p></td> |
| 141 |
<td>a new ESSID for the interface. |
| 142 |
</td> |
| 143 |
</tr> |
| 144 |
</tbody> |
| 145 |
</table></div> |
| 146 |
</div> |
| 147 |
<hr> |
| 148 |
<div class="refsect2" title="oobs_iface_wireless_get_key ()"> |
| 149 |
<a name="oobs-iface-wireless-get-key"></a><h3>oobs_iface_wireless_get_key ()</h3> |
| 150 |
<pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_iface_wireless_get_key (<em class="parameter"><code><a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a> *iface</code></em>);</pre> |
| 151 |
<p> |
| 152 |
Returns the network key associated to the ESSID that |
| 153 |
this interface uses. |
| 154 |
</p> |
| 155 |
<div class="variablelist"><table border="0"> |
| 156 |
<col align="left" valign="top"> |
| 157 |
<tbody> |
| 158 |
<tr> |
| 159 |
<td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td> |
| 160 |
<td>an <a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a>. |
| 161 |
</td> |
| 162 |
</tr> |
| 163 |
<tr> |
| 164 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 165 |
<td> A pointer to the network key as a string, |
| 166 |
or <code class="literal">NULL</code> if it's unset. This string must |
| 167 |
not be freed, modified or stored. |
| 168 |
</td> |
| 169 |
</tr> |
| 170 |
</tbody> |
| 171 |
</table></div> |
| 172 |
</div> |
| 173 |
<hr> |
| 174 |
<div class="refsect2" title="oobs_iface_wireless_set_key ()"> |
| 175 |
<a name="oobs-iface-wireless-set-key"></a><h3>oobs_iface_wireless_set_key ()</h3> |
| 176 |
<pre class="programlisting"><span class="returnvalue">void</span> oobs_iface_wireless_set_key (<em class="parameter"><code><a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a> *iface</code></em>, |
| 177 |
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);</pre> |
| 178 |
<p> |
| 179 |
Sets a new network key for the ESSID that the interface uses. |
| 180 |
</p> |
| 181 |
<div class="variablelist"><table border="0"> |
| 182 |
<col align="left" valign="top"> |
| 183 |
<tbody> |
| 184 |
<tr> |
| 185 |
<td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td> |
| 186 |
<td>an <a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a>. |
| 187 |
</td> |
| 188 |
</tr> |
| 189 |
<tr> |
| 190 |
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> |
| 191 |
<td>a new key for the ESSID, or <code class="literal">NULL</code> to unset it. |
| 192 |
</td> |
| 193 |
</tr> |
| 194 |
</tbody> |
| 195 |
</table></div> |
| 196 |
</div> |
| 197 |
<hr> |
| 198 |
<div class="refsect2" title="oobs_iface_wireless_get_key_type ()"> |
| 199 |
<a name="oobs-iface-wireless-get-key-type"></a><h3>oobs_iface_wireless_get_key_type ()</h3> |
| 200 |
<pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_iface_wireless_get_key_type (<em class="parameter"><code><a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a> *iface</code></em>);</pre> |
| 201 |
<p> |
| 202 |
Returns the type of key that the interface uses. |
| 203 |
</p> |
| 204 |
<div class="variablelist"><table border="0"> |
| 205 |
<col align="left" valign="top"> |
| 206 |
<tbody> |
| 207 |
<tr> |
| 208 |
<td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td> |
| 209 |
<td>an <a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a>. |
| 210 |
</td> |
| 211 |
</tr> |
| 212 |
<tr> |
| 213 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 214 |
<td> The key type. |
| 215 |
</td> |
| 216 |
</tr> |
| 217 |
</tbody> |
| 218 |
</table></div> |
| 219 |
</div> |
| 220 |
<hr> |
| 221 |
<div class="refsect2" title="oobs_iface_wireless_set_key_type ()"> |
| 222 |
<a name="oobs-iface-wireless-set-key-type"></a><h3>oobs_iface_wireless_set_key_type ()</h3> |
| 223 |
<pre class="programlisting"><span class="returnvalue">void</span> oobs_iface_wireless_set_key_type (<em class="parameter"><code><a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a> *iface</code></em>, |
| 224 |
<em class="parameter"><code>const <span class="type">gchar</span> *key_type</code></em>);</pre> |
| 225 |
<p> |
| 226 |
Sets the type of the contained key. |
| 227 |
</p> |
| 228 |
<div class="variablelist"><table border="0"> |
| 229 |
<col align="left" valign="top"> |
| 230 |
<tbody> |
| 231 |
<tr> |
| 232 |
<td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td> |
| 233 |
<td>an <a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a>. |
| 234 |
</td> |
| 235 |
</tr> |
| 236 |
<tr> |
| 237 |
<td><p><span class="term"><em class="parameter"><code>key_type</code></em> :</span></p></td> |
| 238 |
<td>a new type to define the key. |
| 239 |
</td> |
| 240 |
</tr> |
| 241 |
</tbody> |
| 242 |
</table></div> |
| 243 |
</div> |
| 244 |
</div> |
| 245 |
<div class="refsect1" title="Property Details"> |
| 246 |
<a name="OobsIfaceWireless.property-details"></a><h2>Property Details</h2> |
| 247 |
<div class="refsect2" title='The "essid" property'> |
| 248 |
<a name="OobsIfaceWireless--essid"></a><h3>The <code class="literal">"essid"</code> property</h3> |
| 249 |
<pre class="programlisting"> "essid" <span class="type">gchar</span>* : Read / Write</pre> |
| 250 |
<p>ESSID.</p> |
| 251 |
<p>Default value: NULL</p> |
| 252 |
</div> |
| 253 |
<hr> |
| 254 |
<div class="refsect2" title='The "key" property'> |
| 255 |
<a name="OobsIfaceWireless--key"></a><h3>The <code class="literal">"key"</code> property</h3> |
| 256 |
<pre class="programlisting"> "key" <span class="type">gchar</span>* : Read / Write</pre> |
| 257 |
<p>Key.</p> |
| 258 |
<p>Default value: NULL</p> |
| 259 |
</div> |
| 260 |
<hr> |
| 261 |
<div class="refsect2" title='The "key-type" property'> |
| 262 |
<a name="OobsIfaceWireless--key-type"></a><h3>The <code class="literal">"key-type"</code> property</h3> |
| 263 |
<pre class="programlisting"> "key-type" <span class="type">gchar</span>* : Read / Write</pre> |
| 264 |
<p>key type.</p> |
| 265 |
<p>Default value: NULL</p> |
| 266 |
</div> |
| 267 |
</div> |
| 268 |
<div class="refsect1" title="See Also"> |
| 269 |
<a name="OobsIfaceWireless.see-also"></a><h2>See Also</h2> |
| 270 |
<a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a>, <a class="link" href="OobsIfacesConfig.html" title="OobsIfacesConfig"><span class="type">OobsIfacesConfig</span></a>, <a class="link" href="OobsIfaceEthernet.html" title="OobsIfaceEthernet"><span class="type">OobsIfaceEthernet</span></a>, |
| 271 |
<a class="link" href="OobsIfaceIRLan.html" title="OobsIfaceIRLan"><span class="type">OobsIfaceIRLan</span></a>, <a class="link" href="OobsIfacePlip.html" title="OobsIfacePlip"><span class="type">OobsIfacePlip</span></a>, <a class="link" href="OobsIfacePPP.html" title="OobsIfacePPP"><span class="type">OobsIfacePPP</span></a>, <a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a> |
| 272 |
</div> |
| 273 |
</div> |
| 274 |
<div class="footer"> |
| 275 |
<hr> |
| 276 |
Generated by GTK-Doc V1.15</div> |
| 277 |
</body> |
| 278 |
</html> |