1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="OobsIfaceWireless">
<refmeta>
<refentrytitle role="top_of_page" id="OobsIfaceWireless.top_of_page">OobsIfaceWireless</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOOBS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>OobsIfaceWireless</refname>
<refpurpose>Object that represents an individual Wireless interface.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="OobsIfaceWireless.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="OobsIfaceWireless-struct">OobsIfaceWireless</link>;
const <link linkend="gchar">gchar</link>* <link linkend="oobs-iface-wireless-get-essid">oobs_iface_wireless_get_essid</link> (<link linkend="OobsIfaceWireless">OobsIfaceWireless</link> *iface);
<link linkend="void">void</link> <link linkend="oobs-iface-wireless-set-essid">oobs_iface_wireless_set_essid</link> (<link linkend="OobsIfaceWireless">OobsIfaceWireless</link> *iface,
const <link linkend="gchar">gchar</link> *essid);
const <link linkend="gchar">gchar</link>* <link linkend="oobs-iface-wireless-get-key">oobs_iface_wireless_get_key</link> (<link linkend="OobsIfaceWireless">OobsIfaceWireless</link> *iface);
<link linkend="void">void</link> <link linkend="oobs-iface-wireless-set-key">oobs_iface_wireless_set_key</link> (<link linkend="OobsIfaceWireless">OobsIfaceWireless</link> *iface,
const <link linkend="gchar">gchar</link> *key);
const <link linkend="gchar">gchar</link>* <link linkend="oobs-iface-wireless-get-key-type">oobs_iface_wireless_get_key_type</link> (<link linkend="OobsIfaceWireless">OobsIfaceWireless</link> *iface);
<link linkend="void">void</link> <link linkend="oobs-iface-wireless-set-key-type">oobs_iface_wireless_set_key_type</link> (<link linkend="OobsIfaceWireless">OobsIfaceWireless</link> *iface,
const <link linkend="gchar">gchar</link> *key_type);
</synopsis>
</refsynopsisdiv>
<refsect1 id="OobsIfaceWireless.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="OobsIface">OobsIface</link>
+----<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link>
+----OobsIfaceWireless
</synopsis>
</refsect1>
<refsect1 id="OobsIfaceWireless.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="OobsIfaceWireless--essid">essid</link>" <link linkend="gchar">gchar</link>* : Read / Write
"<link linkend="OobsIfaceWireless--key">key</link>" <link linkend="gchar">gchar</link>* : Read / Write
"<link linkend="OobsIfaceWireless--key-type">key-type</link>" <link linkend="gchar">gchar</link>* : Read / Write
</synopsis>
</refsect1>
<refsect1 id="OobsIfaceWireless.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="OobsIfaceWireless.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="OobsIfaceWireless-struct" role="struct">
<title>OobsIfaceWireless</title>
<indexterm zone="OobsIfaceWireless-struct"><primary>OobsIfaceWireless</primary></indexterm><programlisting>typedef struct _OobsIfaceWireless OobsIfaceWireless;</programlisting>
<para>
</para></refsect2>
<refsect2 id="oobs-iface-wireless-get-essid" role="function">
<title>oobs_iface_wireless_get_essid ()</title>
<indexterm zone="oobs-iface-wireless-get-essid"><primary>oobs_iface_wireless_get_essid</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_iface_wireless_get_essid (<link linkend="OobsIfaceWireless">OobsIfaceWireless</link> *iface);</programlisting>
<para>
Returns the network identification (ESSID) that this interface uses.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> an <link linkend="OobsIfaceWireless"><type>OobsIfaceWireless</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the network identification as a string. This
string must not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-wireless-set-essid" role="function">
<title>oobs_iface_wireless_set_essid ()</title>
<indexterm zone="oobs-iface-wireless-set-essid"><primary>oobs_iface_wireless_set_essid</primary></indexterm><programlisting><link linkend="void">void</link> oobs_iface_wireless_set_essid (<link linkend="OobsIfaceWireless">OobsIfaceWireless</link> *iface,
const <link linkend="gchar">gchar</link> *essid);</programlisting>
<para>
Sets a new network identification (ESSID),
overwriting the previous one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIfaceWireless"><type>OobsIfaceWireless</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>essid</parameter> :</term>
<listitem><simpara> a new ESSID for the interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-wireless-get-key" role="function">
<title>oobs_iface_wireless_get_key ()</title>
<indexterm zone="oobs-iface-wireless-get-key"><primary>oobs_iface_wireless_get_key</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_iface_wireless_get_key (<link linkend="OobsIfaceWireless">OobsIfaceWireless</link> *iface);</programlisting>
<para>
Returns the network key associated to the ESSID that
this interface uses.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> an <link linkend="OobsIfaceWireless"><type>OobsIfaceWireless</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the network key as a string,
or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if it's unset. This string must
not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-wireless-set-key" role="function">
<title>oobs_iface_wireless_set_key ()</title>
<indexterm zone="oobs-iface-wireless-set-key"><primary>oobs_iface_wireless_set_key</primary></indexterm><programlisting><link linkend="void">void</link> oobs_iface_wireless_set_key (<link linkend="OobsIfaceWireless">OobsIfaceWireless</link> *iface,
const <link linkend="gchar">gchar</link> *key);</programlisting>
<para>
Sets a new network key for the ESSID that the interface uses.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> an <link linkend="OobsIfaceWireless"><type>OobsIfaceWireless</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara> a new key for the ESSID, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to unset it.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-wireless-get-key-type" role="function">
<title>oobs_iface_wireless_get_key_type ()</title>
<indexterm zone="oobs-iface-wireless-get-key-type"><primary>oobs_iface_wireless_get_key_type</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_iface_wireless_get_key_type (<link linkend="OobsIfaceWireless">OobsIfaceWireless</link> *iface);</programlisting>
<para>
Returns the type of key that the interface uses.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> an <link linkend="OobsIfaceWireless"><type>OobsIfaceWireless</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The key type.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-wireless-set-key-type" role="function">
<title>oobs_iface_wireless_set_key_type ()</title>
<indexterm zone="oobs-iface-wireless-set-key-type"><primary>oobs_iface_wireless_set_key_type</primary></indexterm><programlisting><link linkend="void">void</link> oobs_iface_wireless_set_key_type (<link linkend="OobsIfaceWireless">OobsIfaceWireless</link> *iface,
const <link linkend="gchar">gchar</link> *key_type);</programlisting>
<para>
Sets the type of the contained key.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> an <link linkend="OobsIfaceWireless"><type>OobsIfaceWireless</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key_type</parameter> :</term>
<listitem><simpara> a new type to define the key.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="OobsIfaceWireless.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="OobsIfaceWireless--essid"><title>The <literal>"essid"</literal> property</title>
<indexterm zone="OobsIfaceWireless--essid"><primary>OobsIfaceWireless:essid</primary></indexterm><programlisting> "essid" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>ESSID.</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="OobsIfaceWireless--key"><title>The <literal>"key"</literal> property</title>
<indexterm zone="OobsIfaceWireless--key"><primary>OobsIfaceWireless:key</primary></indexterm><programlisting> "key" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>Key.</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="OobsIfaceWireless--key-type"><title>The <literal>"key-type"</literal> property</title>
<indexterm zone="OobsIfaceWireless--key-type"><primary>OobsIfaceWireless:key-type</primary></indexterm><programlisting> "key-type" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>key type.</para><para>Default value: NULL</para>
</refsect2>
</refsect1>
</refentry>
|
