[gnomeweb-wml] nm: update NM 0.8 libnm-util docs
- From: Dan Williams <dcbw src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnomeweb-wml] nm: update NM 0.8 libnm-util docs
- Date: Wed, 20 Jul 2011 03:47:20 +0000 (UTC)
commit a2d043e07c424e57acbf577be2b546ffa5012591
Author: Dan Williams <dcbw redhat com>
Date: Tue Jul 19 22:37:19 2011 -0500
nm: update NM 0.8 libnm-util docs
.../developers/libnm-util/08/NMSetting.html | 17 +-
.../developers/libnm-util/08/NMSetting8021x.html | 34 ++-
.../libnm-util/08/NMSettingBluetooth.html | 70 +++-
.../developers/libnm-util/08/NMSettingCdma.html | 32 ++-
.../developers/libnm-util/08/NMSettingGsm.html | 236 ++++++++++---
.../libnm-util/08/NMSettingIP4Config.html | 361 ++++++++++++-------
.../libnm-util/08/NMSettingIP6Config.html | 348 ++++++++++++-------
.../developers/libnm-util/08/NMSettingPPP.html | 49 +++-
.../developers/libnm-util/08/NMSettingPPPOE.html | 54 +++-
.../developers/libnm-util/08/NMSettingSerial.html | 79 +++--
.../developers/libnm-util/08/NMSettingVPN.html | 112 +++++--
.../developers/libnm-util/08/NMSettingWired.html | 140 ++++++---
.../libnm-util/08/NMSettingWireless.html | 237 +++++++++----
.../libnm-util/08/NMSettingWirelessSecurity.html | 293 +++++++++++-----
.../developers/libnm-util/08/api-index-full.html | 35 ++-
.../developers/libnm-util/08/ch01.html | 27 +-
.../developers/libnm-util/08/index.html | 26 +-
.../libnm-util/08/libnm-util-nm-utils.html | 16 +-
18 files changed, 1499 insertions(+), 667 deletions(-)
---
diff --git a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSetting.html b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSetting.html
index 51ade09..a67b3b2 100644
--- a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSetting.html
+++ b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSetting.html
@@ -291,34 +291,33 @@ It should only be accessed through the functions described below.
<em class="parameter"><code>const <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
<em class="parameter"><code><a href="../gobject/gobject-GParamSpec.html#GParamFlags"><span class="type">GParamFlags</span></a> flags</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>The setting for which properties are being iterated, given to
+<a class="link" href="NMSetting.html#nm-setting-enumerate-values" title="nm_setting_enumerate_values ()"><code class="function">nm_setting_enumerate_values()</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em>Â:</span></p></td>
-<td>
+<td>The value/property name
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em>Â:</span></p></td>
-<td>
+<td>The property's value
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em>Â:</span></p></td>
-<td>
+<td>The property's flags, like <a class="link" href="NMSetting.html#NM-SETTING-PARAM-SECRET:CAPS" title="NM_SETTING_PARAM_SECRET"><code class="literal">NM_SETTING_PARAM_SECRET</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>Â:</span></p></td>
-<td>
+<td>User data passed to <a class="link" href="NMSetting.html#nm-setting-enumerate-values" title="nm_setting_enumerate_values ()"><code class="function">nm_setting_enumerate_values()</code></a>
</td>
</tr>
</tbody>
@@ -640,10 +639,10 @@ be set to <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="li
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>results</code></em>Â:</span></p></td>
-<td> if the settings differ, on return a
+<td>if the settings differ, on return a
hash table mapping the differing keys to one or more <a class="link" href="NMSetting.html#NMSettingDiffResult" title="enum NMSettingDiffResult"><span class="type">NMSettingDiffResult</span></a>
values OR-ed together. If the settings do not differ, any hash table passed
-in is unmodified. If no hash table is passed in, a new one is created. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 guint32]</span>
+in is unmodified. If no hash table is passed in, a new one is created.
</td>
</tr>
<tr>
diff --git a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSetting8021x.html b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSetting8021x.html
index bbd7c80..d4f2d7a 100644
--- a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSetting8021x.html
+++ b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSetting8021x.html
@@ -332,15 +332,33 @@ following books.
<hr>
<div class="refsect2" title="enum NMSetting8021xError">
<a name="NMSetting8021xError"></a><h3>enum NMSetting8021xError</h3>
-<pre class="programlisting">typedef enum
-{
+<pre class="programlisting">typedef enum {
NM_SETTING_802_1X_ERROR_UNKNOWN = 0,
NM_SETTING_802_1X_ERROR_INVALID_PROPERTY,
NM_SETTING_802_1X_ERROR_MISSING_PROPERTY
} NMSetting8021xError;
</pre>
-<p>
-</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><a name="NM-SETTING-802-1X-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_802_1X_ERROR_UNKNOWN</code></span></p></td>
+<td>unknown or unclassified error
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-802-1X-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_802_1X_ERROR_INVALID_PROPERTY</code></span></p></td>
+<td>the property was invalid
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-802-1X-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_802_1X_ERROR_MISSING_PROPERTY</code></span></p></td>
+<td>the property was missing and is
+required
+</td>
+</tr>
+</tbody>
+</table></div>
</div>
<hr>
<div class="refsect2" title="NM_TYPE_SETTING_802_1X_ERROR">
@@ -1760,7 +1778,7 @@ authentication method.
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
<td> the private key password used to decrypt the private key if
previously set with <a class="link" href="NMSetting8021x.html#nm-setting-802-1x-set-private-key-from-file" title="nm_setting_802_1x_set_private_key_from_file ()"><code class="function">nm_setting_802_1x_set_private_key_from_file()</code></a>,
- <code class="function">nm_setting_802_1x_set_private_key_path()</code>, or the
+ <a class="link" href="NMSetting8021x.html#nm-setting-802-1x-set-private-key" title="nm_setting_802_1x_set_private_key ()"><code class="function">nm_setting_802_1x_set_private_key()</code></a>, or the
<a class="link" href="NMSetting8021x.html#NMSetting8021x--private-key-password" title='The "private-key-password" property'><span class="type">"private-key-password"</span></a> property.
</td>
</tr>
@@ -1952,7 +1970,7 @@ authentication method.
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
<td> the private key password used to decrypt the private key if
previously set with <a class="link" href="NMSetting8021x.html#nm-setting-802-1x-set-phase2-private-key-from-file" title="nm_setting_802_1x_set_phase2_private_key_from_file ()"><code class="function">nm_setting_802_1x_set_phase2_private_key_from_file()</code></a>,
- <code class="function">nm_setting_802_1x_set_phase2_private_key_path()</code>, or the
+ <a class="link" href="NMSetting8021x.html#nm-setting-802-1x-set-phase2-private-key" title="nm_setting_802_1x_set_phase2_private_key ()"><code class="function">nm_setting_802_1x_set_phase2_private_key()</code></a>, or the
<a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-private-key-password" title='The "phase2-private-key-password" property'><span class="type">"phase2-private-key-password"</span></a> property.
</td>
</tr>
@@ -2767,8 +2785,8 @@ properties. Setting this property directly is discouraged; use the
Private key data used by "phase 2" inner authentication methods.
</p>
<p>
-Contains the "phase 2" inner private key if the <span class="type">"auth"</span> or
-<a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-autheap" title='The "phase2-autheap" property'><span class="type">"phase2-autheap"</span></a> property is set to 'tls'. Setting this
+Contains the "phase 2" inner private key if the <a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-auth" title='The "phase2-auth" property'><span class="type">"phase2-auth"</span></a>
+or <a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-autheap" title='The "phase2-autheap" property'><span class="type">"phase2-autheap"</span></a> property is set to 'tls'. Setting this
property directly is discouraged; use the
<a class="link" href="NMSetting8021x.html#nm-setting-802-1x-set-phase2-private-key" title="nm_setting_802_1x_set_phase2_private_key ()"><code class="function">nm_setting_802_1x_set_phase2_private_key()</code></a> function instead.
</p>
diff --git a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingBluetooth.html b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingBluetooth.html
index 81a2ed2..d00b48b 100644
--- a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingBluetooth.html
+++ b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingBluetooth.html
@@ -35,13 +35,16 @@
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NMSettingBluetooth.top_of_page"></a>NMSettingBluetooth</span></h2>
-<p>NMSettingBluetooth</p>
+<p>NMSettingBluetooth â Describes Bluetooth connection properties</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="NMSettingBluetooth.synopsis"></a><h2>Synopsis</h2>
-<pre class="synopsis">#define <a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-SETTING-NAME:CAPS" title="NM_SETTING_BLUETOOTH_SETTING_NAME">NM_SETTING_BLUETOOTH_SETTING_NAME</a>
+<pre class="synopsis">
+#include <nm-setting-bluetooth.h>
+
+#define <a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-SETTING-NAME:CAPS" title="NM_SETTING_BLUETOOTH_SETTING_NAME">NM_SETTING_BLUETOOTH_SETTING_NAME</a>
enum <a class="link" href="NMSettingBluetooth.html#NMSettingBluetoothError" title="enum NMSettingBluetoothError">NMSettingBluetoothError</a>;
#define <a class="link" href="NMSettingBluetooth.html#NM-TYPE-SETTING-BLUETOOTH-ERROR:CAPS" title="NM_TYPE_SETTING_BLUETOOTH_ERROR">NM_TYPE_SETTING_BLUETOOTH_ERROR</a>
#define <a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-ERROR:CAPS" title="NM_SETTING_BLUETOOTH_ERROR">NM_SETTING_BLUETOOTH_ERROR</a>
@@ -77,6 +80,10 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect1" title="Description">
<a name="NMSettingBluetooth.description"></a><h2>Description</h2>
<p>
+The <a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes
+properties necessary for connection to devices that provide network
+connections via the Bluetooth Dial-Up Networking (DUN) and Network Access
+Point (NAP) profiles.
</p>
</div>
<div class="refsect1" title="Details">
@@ -91,16 +98,41 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<hr>
<div class="refsect2" title="enum NMSettingBluetoothError">
<a name="NMSettingBluetoothError"></a><h3>enum NMSettingBluetoothError</h3>
-<pre class="programlisting">typedef enum
-{
+<pre class="programlisting">typedef enum {
NM_SETTING_BLUETOOTH_ERROR_UNKNOWN = 0,
NM_SETTING_BLUETOOTH_ERROR_INVALID_PROPERTY,
NM_SETTING_BLUETOOTH_ERROR_MISSING_PROPERTY,
NM_SETTING_BLUETOOTH_ERROR_TYPE_SETTING_NOT_FOUND,
} NMSettingBluetoothError;
</pre>
-<p>
-</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><a name="NM-SETTING-BLUETOOTH-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_BLUETOOTH_ERROR_UNKNOWN</code></span></p></td>
+<td>unknown or unclassified error
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-BLUETOOTH-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_BLUETOOTH_ERROR_INVALID_PROPERTY</code></span></p></td>
+<td>the property was invalid
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-BLUETOOTH-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_BLUETOOTH_ERROR_MISSING_PROPERTY</code></span></p></td>
+<td>the property was missing and is
+required
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-BLUETOOTH-ERROR-TYPE-SETTING-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">NM_SETTING_BLUETOOTH_ERROR_TYPE_SETTING_NOT_FOUND</code></span></p></td>
+<td>the connection
+did not contain a required type setting, ie for DUN connections the connection
+must also contain an <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> or <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> as appropriate
+</td>
+</tr>
+</tbody>
+</table></div>
</div>
<hr>
<div class="refsect2" title="NM_TYPE_SETTING_BLUETOOTH_ERROR">
@@ -123,12 +155,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-bluetooth-error-quark"></a><h3>nm_setting_bluetooth_error_quark ()</h3>
<pre class="programlisting"><a href="../glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_setting_bluetooth_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Registers an error quark for <a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> if necessary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the error quark used for <a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> errors.
</td>
</tr></tbody>
</table></div>
@@ -155,6 +188,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">#define NM_SETTING_BLUETOOTH_TYPE_DUN "dun"
</pre>
<p>
+Connection type describing a connection to devices that support the Bluetooth
+DUN profile.
</p>
</div>
<hr>
@@ -163,6 +198,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">#define NM_SETTING_BLUETOOTH_TYPE_PANU "panu"
</pre>
<p>
+Connection type describing a connection to devices that support the Bluetooth
+NAP (Network Access Point) protocol, which accepts connections via PANU.
</p>
</div>
<hr>
@@ -208,12 +245,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-bluetooth-new"></a><h3>nm_setting_bluetooth_new ()</h3>
<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_bluetooth_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Creates a new <a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> object with default values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the new empty <a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> object
</td>
</tr></tbody>
</table></div>
@@ -223,18 +261,20 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-bluetooth-get-bdaddr"></a><h3>nm_setting_bluetooth_get_bdaddr ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> * nm_setting_bluetooth_get_bdaddr (<em class="parameter"><code><a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> *setting</code></em>);</pre>
<p>
+Gets the Bluetooth address of the remote device which this setting
+describes a connection to.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the Bluetooth address
</td>
</tr>
</tbody>
@@ -246,18 +286,20 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_bluetooth_get_connection_type
(<em class="parameter"><code><a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> *setting</code></em>);</pre>
<p>
+Returns the connection method for communicating with the remote device (i.e.
+either DUN to a DUN-capable device or PANU to a NAP-capable device).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the type, either <code class="literal">NM_SETTING_BLUETOOTH_PANU</code> or <code class="literal">NM_SETTING_BLUETOOTH_DUN</code>
</td>
</tr>
</tbody>
@@ -278,8 +320,8 @@ The Bluetooth address of the device.
<a name="NMSettingBluetooth--type"></a><h3>The <code class="literal">"type"</code> property</h3>
<pre class="programlisting"> "type" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>
-Either 'dun' for Dial-Up Networking connections (not yet supported) or
-'panu' for Personal Area Networking connections.
+Either 'dun' for Dial-Up Networking connections or 'panu' for Personal
+Area Networking connections to devices supporting the NAP profile.
</p>
<p>Default value: NULL</p>
</div>
diff --git a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingCdma.html b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingCdma.html
index 79b2451..1174df3 100644
--- a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingCdma.html
+++ b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingCdma.html
@@ -97,16 +97,40 @@ networks, including those using CDMA2000/EVDO technology.
<hr>
<div class="refsect2" title="enum NMSettingCdmaError">
<a name="NMSettingCdmaError"></a><h3>enum NMSettingCdmaError</h3>
-<pre class="programlisting">typedef enum
-{
+<pre class="programlisting">typedef enum {
NM_SETTING_CDMA_ERROR_UNKNOWN = 0,
NM_SETTING_CDMA_ERROR_INVALID_PROPERTY,
NM_SETTING_CDMA_ERROR_MISSING_PROPERTY,
NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING
} NMSettingCdmaError;
</pre>
-<p>
-</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><a name="NM-SETTING-CDMA-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_CDMA_ERROR_UNKNOWN</code></span></p></td>
+<td>unknown or unclassified error
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-CDMA-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_CDMA_ERROR_INVALID_PROPERTY</code></span></p></td>
+<td>the property was invalid
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-CDMA-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_CDMA_ERROR_MISSING_PROPERTY</code></span></p></td>
+<td>the property was missing and is
+required
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-CDMA-ERROR-MISSING-SERIAL-SETTING:CAPS"></a><span class="term"><code class="literal">NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING</code></span></p></td>
+<td>the required <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a>
+is missing in the connection
+</td>
+</tr>
+</tbody>
+</table></div>
</div>
<hr>
<div class="refsect2" title="NM_TYPE_SETTING_CDMA_ERROR">
diff --git a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingGsm.html b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingGsm.html
index c3c9bcb..9c4cc21 100644
--- a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingGsm.html
+++ b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingGsm.html
@@ -35,13 +35,16 @@
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NMSettingGsm.top_of_page"></a>NMSettingGsm</span></h2>
-<p>NMSettingGsm</p>
+<p>NMSettingGsm â Describes GSM/3GPP-based mobile broadband properties</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="NMSettingGsm.synopsis"></a><h2>Synopsis</h2>
-<pre class="synopsis">#define <a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-SETTING-NAME:CAPS" title="NM_SETTING_GSM_SETTING_NAME">NM_SETTING_GSM_SETTING_NAME</a>
+<pre class="synopsis">
+#include <nm-setting-gsm.h>
+
+#define <a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-SETTING-NAME:CAPS" title="NM_SETTING_GSM_SETTING_NAME">NM_SETTING_GSM_SETTING_NAME</a>
enum <a class="link" href="NMSettingGsm.html#NMSettingGsmError" title="enum NMSettingGsmError">NMSettingGsmError</a>;
#define <a class="link" href="NMSettingGsm.html#NM-TYPE-SETTING-GSM-ERROR:CAPS" title="NM_TYPE_SETTING_GSM_ERROR">NM_TYPE_SETTING_GSM_ERROR</a>
#define <a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-ERROR:CAPS" title="NM_SETTING_GSM_ERROR">NM_SETTING_GSM_ERROR</a>
@@ -108,6 +111,9 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect1" title="Description">
<a name="NMSettingGsm.description"></a><h2>Description</h2>
<p>
+The <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes
+properties that allow connections to 3GPP-based mobile broadband
+networks, including those using GPRS/EDGE and UMTS/HSPA technology.
</p>
</div>
<div class="refsect1" title="Details">
@@ -122,16 +128,40 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<hr>
<div class="refsect2" title="enum NMSettingGsmError">
<a name="NMSettingGsmError"></a><h3>enum NMSettingGsmError</h3>
-<pre class="programlisting">typedef enum
-{
+<pre class="programlisting">typedef enum {
NM_SETTING_GSM_ERROR_UNKNOWN = 0,
NM_SETTING_GSM_ERROR_INVALID_PROPERTY,
NM_SETTING_GSM_ERROR_MISSING_PROPERTY,
NM_SETTING_GSM_ERROR_MISSING_SERIAL_SETTING
} NMSettingGsmError;
</pre>
-<p>
-</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><a name="NM-SETTING-GSM-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_ERROR_UNKNOWN</code></span></p></td>
+<td>unknown or unclassified error
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_ERROR_INVALID_PROPERTY</code></span></p></td>
+<td>the property was invalid
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_ERROR_MISSING_PROPERTY</code></span></p></td>
+<td>the property was missing and is
+required
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-ERROR-MISSING-SERIAL-SETTING:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_ERROR_MISSING_SERIAL_SETTING</code></span></p></td>
+<td>the required <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a>
+is missing in the connection
+</td>
+</tr>
+</tbody>
+</table></div>
</div>
<hr>
<div class="refsect2" title="NM_TYPE_SETTING_GSM_ERROR">
@@ -154,12 +184,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-gsm-error-quark"></a><h3>nm_setting_gsm_error_quark ()</h3>
<pre class="programlisting"><a href="../glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_setting_gsm_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Registers an error quark for <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> if necessary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the error quark used for <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> errors.
</td>
</tr></tbody>
</table></div>
@@ -304,7 +335,43 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
} NMSettingGsmNetworkType;
</pre>
<p>
+<a class="link" href="NMSettingGsm.html#NMSettingGsmNetworkType" title="enum NMSettingGsmNetworkType"><span class="type">NMSettingGsmNetworkType</span></a> values indicate the allowed access technologies
+the device may use when connecting to this network.
</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><a name="NM-SETTING-GSM-NETWORK-TYPE-ANY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_NETWORK_TYPE_ANY</code></span></p></td>
+<td>any access technology may be used
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-NETWORK-TYPE-UMTS-HSPA:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA</code></span></p></td>
+<td>only 3G-type (UMTS and HSPA)
+technologies may be used
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-NETWORK-TYPE-GPRS-EDGE:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE</code></span></p></td>
+<td>only 2G-type (GPRS and EDGE)
+technologies may be used
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-NETWORK-TYPE-PREFER-UMTS-HSPA:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA</code></span></p></td>
+<td>3G-type technologies are
+preferred but 2G-type technologies may be used as a fallback
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-NETWORK-TYPE-PREFER-GPRS-EDGE:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE</code></span></p></td>
+<td>2G-type technologies are
+preferred but 3G-type technologies may be used as a fallback
+</td>
+</tr>
+</tbody>
+</table></div>
</div>
<hr>
<div class="refsect2" title="enum NMSettingGsmNetworkBand">
@@ -324,10 +391,93 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
NM_SETTING_GSM_BAND_U900 = 0x00000400, /* WCDMA 3GPP UMTS 900 MHz (Class VIII) */
NM_SETTING_GSM_BAND_U17IX = 0x00000800, /* WCDMA 3GPP UMTS 1700 MHz (Class IX) */
NM_SETTING_GSM_BAND_U1900 = 0x00001000, /* WCDMA 3GPP UMTS 1900 MHz (Class II) */
+ NM_SETTING_GSM_BAND_U2600 = 0x00002000, /* WCDMA 3GPP UMTS 2600 MHz (Class VII, internal) */
} NMSettingGsmNetworkBand;
</pre>
<p>
+<a class="link" href="NMSettingGsm.html#NMSettingGsmNetworkBand" title="enum NMSettingGsmNetworkBand"><span class="type">NMSettingGsmNetworkBand</span></a> values indicate the allowed frequency bands
+the device may use when connecting to this network.
</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><a name="NM-SETTING-GSM-BAND-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_UNKNOWN</code></span></p></td>
+<td>unknown or no band specified
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-BAND-ANY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_ANY</code></span></p></td>
+<td>any band is allowed
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-BAND-EGSM:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_EGSM</code></span></p></td>
+<td>900 MHz original GSM band
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-BAND-DCS:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_DCS</code></span></p></td>
+<td>1800 MHz DCS band
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-BAND-PCS:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_PCS</code></span></p></td>
+<td>US 1900 MHz PCS band
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-BAND-G850:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_G850</code></span></p></td>
+<td>US 850 MHz Cellular band
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-BAND-U2100:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_U2100</code></span></p></td>
+<td>WCDMA 3GPP UMTS 2100 MHz (Class I)
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-BAND-U1800:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_U1800</code></span></p></td>
+<td>WCDMA 3GPP UMTS 1800 MHz (Class III)
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-BAND-U17IV:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_U17IV</code></span></p></td>
+<td>WCDMA 3GPP AWS 1700/2100 MHz (Class IV)
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-BAND-U800:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_U800</code></span></p></td>
+<td>WCDMA 3GPP UMTS 800 MHz (Class VI)
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-BAND-U850:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_U850</code></span></p></td>
+<td>WCDMA 3GPP UMTS 850 MHz (Class V)
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-BAND-U900:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_U900</code></span></p></td>
+<td>WCDMA 3GPP UMTS 900 MHz (Class VIII)
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-BAND-U17IX:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_U17IX</code></span></p></td>
+<td>WCDMA 3GPP UMTS 1700 MHz (Class IX)
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-BAND-U1900:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_U1900</code></span></p></td>
+<td>WCDMA 3GPP UMTS 1900 MHz (Class II)
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-GSM-BAND-U2600:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_U2600</code></span></p></td>
+<td>WCDMA 3GPP UMTS 2600 MHz (Class VII, internal)
+</td>
+</tr>
+</tbody>
+</table></div>
</div>
<hr>
<div class="refsect2" title="NMSettingGsm">
@@ -372,12 +522,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-gsm-new"></a><h3>nm_setting_gsm_new ()</h3>
<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_gsm_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Creates a new <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> object with default values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the new empty <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> object
</td>
</tr></tbody>
</table></div>
@@ -386,19 +537,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_gsm_get_number ()">
<a name="nm-setting-gsm-get-number"></a><h3>nm_setting_gsm_get_number ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_gsm_get_number (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--number" title='The "number" property'><span class="type">"number"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -408,19 +557,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_gsm_get_username ()">
<a name="nm-setting-gsm-get-username"></a><h3>nm_setting_gsm_get_username ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_gsm_get_username (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--username" title='The "username" property'><span class="type">"username"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -430,19 +577,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_gsm_get_password ()">
<a name="nm-setting-gsm-get-password"></a><h3>nm_setting_gsm_get_password ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_gsm_get_password (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--password" title='The "password" property'><span class="type">"password"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -452,19 +597,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_gsm_get_apn ()">
<a name="nm-setting-gsm-get-apn"></a><h3>nm_setting_gsm_get_apn ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_gsm_get_apn (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--apn" title='The "apn" property'><span class="type">"apn"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -474,19 +617,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_gsm_get_network_id ()">
<a name="nm-setting-gsm-get-network-id"></a><h3>nm_setting_gsm_get_network_id ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_gsm_get_network_id (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--network-id" title='The "network-id" property'><span class="type">"network-id"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -496,19 +637,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_gsm_get_network_type ()">
<a name="nm-setting-gsm-get-network-type"></a><h3>nm_setting_gsm_get_network_type ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> nm_setting_gsm_get_network_type (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--network-type" title='The "network-type" property'><span class="type">"network-type"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -518,19 +657,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_gsm_get_allowed_bands ()">
<a name="nm-setting-gsm-get-allowed-bands"></a><h3>nm_setting_gsm_get_allowed_bands ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_gsm_get_allowed_bands (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--allowed-bands" title='The "allowed-bands" property'><span class="type">"allowed-bands"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -540,19 +677,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_gsm_get_pin ()">
<a name="nm-setting-gsm-get-pin"></a><h3>nm_setting_gsm_get_pin ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_gsm_get_pin (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--pin" title='The "pin" property'><span class="type">"pin"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -562,19 +697,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_gsm_get_home_only ()">
<a name="nm-setting-gsm-get-home-only"></a><h3>nm_setting_gsm_get_home_only ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_gsm_get_home_only (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--home-only" title='The "home-only" property'><span class="type">"home-only"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -632,7 +765,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"> "allowed-bands" <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct</pre>
<p>
Bitfield of allowed frequency bands. Note that not all devices allow
-frequency band control.
+frequency band control. Permitted values are those specified by
+<a class="link" href="NMSettingGsm.html#NMSettingGsmNetworkBand" title="enum NMSettingGsmNetworkBand"><span class="type">NMSettingGsmNetworkBand</span></a>.
</p>
<p>Allowed values: <= 1</p>
<p>Default value: 1</p>
@@ -691,9 +825,9 @@ roaming control of the device is not otherwise possible.
<pre class="programlisting"> "network-type" <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write / Construct</pre>
<p>
Network preference to force the device to only use specific network
-technologies. The permitted values are: -1: any, 0: 3G only,
-1: GPRS/EDGE only, 2: prefer 3G, and 3: prefer 2G. Note that not all
-devices allow network preference control.
+technologies. Permitted values are those specified by
+<a class="link" href="NMSettingGsm.html#NMSettingGsmNetworkType" title="enum NMSettingGsmNetworkType"><span class="type">NMSettingGsmNetworkType</span></a>. Note that not all devices allow network
+preference control.
</p>
<p>Allowed values: [-1,3]</p>
<p>Default value: -1</p>
@@ -704,9 +838,9 @@ devices allow network preference control.
<pre class="programlisting"> "number" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>
Number to dial when establishing a PPP data session with the GSM-based
-mobile broadband network. In most cases, leave the number blank and a
-number selecting the APN specified in the 'apn' property will be used
-automatically when required.
+mobile broadband network. Many modems do not require PPP for connections
+to the mobile network and thus this property should be left blank, which
+allows NetworkManager to select the appropriate settings automatically.
</p>
<p>Default value: NULL</p>
</div>
diff --git a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingIP4Config.html b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingIP4Config.html
index 5c52539..5667dc1 100644
--- a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingIP4Config.html
+++ b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingIP4Config.html
@@ -35,13 +35,16 @@
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NMSettingIP4Config.top_of_page"></a>NMSettingIP4Config</span></h2>
-<p>NMSettingIP4Config</p>
+<p>NMSettingIP4Config â Describes IPv4 addressing, routing, and name service properties</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="NMSettingIP4Config.synopsis"></a><h2>Synopsis</h2>
-<pre class="synopsis">#define <a class="link" href="NMSettingIP4Config.html#NM-SETTING-IP4-CONFIG-SETTING-NAME:CAPS" title="NM_SETTING_IP4_CONFIG_SETTING_NAME">NM_SETTING_IP4_CONFIG_SETTING_NAME</a>
+<pre class="synopsis">
+#include <nm-setting-ip4-config.h>
+
+#define <a class="link" href="NMSettingIP4Config.html#NM-SETTING-IP4-CONFIG-SETTING-NAME:CAPS" title="NM_SETTING_IP4_CONFIG_SETTING_NAME">NM_SETTING_IP4_CONFIG_SETTING_NAME</a>
enum <a class="link" href="NMSettingIP4Config.html#NMSettingIP4ConfigError" title="enum NMSettingIP4ConfigError">NMSettingIP4ConfigError</a>;
#define <a class="link" href="NMSettingIP4Config.html#NM-TYPE-SETTING-IP4-CONFIG-ERROR:CAPS" title="NM_TYPE_SETTING_IP4_CONFIG_ERROR">NM_TYPE_SETTING_IP4_CONFIG_ERROR</a>
#define <a class="link" href="NMSettingIP4Config.html#NM-SETTING-IP4-CONFIG-ERROR:CAPS" title="NM_SETTING_IP4_CONFIG_ERROR">NM_SETTING_IP4_CONFIG_ERROR</a>
@@ -81,7 +84,7 @@ typedef <a class="link" href="NMSettingIP4Config.html#NMIP4Address"
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> gateway</code></em>);
typedef <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route">NMIP4Route</a>;
<a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="returnvalue">NMIP4Route</span></a> * <a class="link" href="NMSettingIP4Config.html#nm-ip4-route-new" title="nm_ip4_route_new ()">nm_ip4_route_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
-<a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="returnvalue">NMIP4Route</span></a> * <a class="link" href="NMSettingIP4Config.html#nm-ip4-route-dup" title="nm_ip4_route_dup ()">nm_ip4_route_dup</a> (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *route</code></em>);
+<a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="returnvalue">NMIP4Route</span></a> * <a class="link" href="NMSettingIP4Config.html#nm-ip4-route-dup" title="nm_ip4_route_dup ()">nm_ip4_route_dup</a> (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *source</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NMSettingIP4Config.html#nm-ip4-route-ref" title="nm_ip4_route_ref ()">nm_ip4_route_ref</a> (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *route</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NMSettingIP4Config.html#nm-ip4-route-unref" title="nm_ip4_route_unref ()">nm_ip4_route_unref</a> (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *route</code></em>);
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NMSettingIP4Config.html#nm-ip4-route-compare" title="nm_ip4_route_compare ()">nm_ip4_route_compare</a> (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *route</code></em>,
@@ -187,6 +190,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect1" title="Description">
<a name="NMSettingIP4Config.description"></a><h2>Description</h2>
<p>
+The <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes
+properties related to IPv4 addressing, routing, and Domain Name Service
</p>
</div>
<div class="refsect1" title="Details">
@@ -201,16 +206,40 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<hr>
<div class="refsect2" title="enum NMSettingIP4ConfigError">
<a name="NMSettingIP4ConfigError"></a><h3>enum NMSettingIP4ConfigError</h3>
-<pre class="programlisting">typedef enum
-{
+<pre class="programlisting">typedef enum {
NM_SETTING_IP4_CONFIG_ERROR_UNKNOWN = 0,
NM_SETTING_IP4_CONFIG_ERROR_INVALID_PROPERTY,
NM_SETTING_IP4_CONFIG_ERROR_MISSING_PROPERTY,
NM_SETTING_IP4_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD
} NMSettingIP4ConfigError;
</pre>
-<p>
-</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><a name="NM-SETTING-IP4-CONFIG-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_IP4_CONFIG_ERROR_UNKNOWN</code></span></p></td>
+<td>unknown or unclassified error
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-IP4-CONFIG-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_IP4_CONFIG_ERROR_INVALID_PROPERTY</code></span></p></td>
+<td>the property was invalid
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-IP4-CONFIG-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_IP4_CONFIG_ERROR_MISSING_PROPERTY</code></span></p></td>
+<td>the property was missing and is
+required
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-IP4-CONFIG-ERROR-NOT-ALLOWED-FOR-METHOD:CAPS"></a><span class="term"><code class="literal">NM_SETTING_IP4_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD</code></span></p></td>
+<td>the property's value is
+not valid with the given IP4 method
+</td>
+</tr>
+</tbody>
+</table></div>
</div>
<hr>
<div class="refsect2" title="NM_TYPE_SETTING_IP4_CONFIG_ERROR">
@@ -233,12 +262,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip4-config-error-quark"></a><h3>nm_setting_ip4_config_error_quark ()</h3>
<pre class="programlisting"><a href="../glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_setting_ip4_config_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Registers an error quark for <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> if necessary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the error quark used for <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> errors.
</td>
</tr></tbody>
</table></div>
@@ -345,6 +375,9 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD_AUTO "auto"
</pre>
<p>
+IPv4 configuration should be automatically determined via a method appropriate
+for the hardware interface, ie DHCP or PPP or some other device-specific
+manner.
</p>
</div>
<hr>
@@ -353,6 +386,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL "link-local"
</pre>
<p>
+IPv4 configuration should be automatically configured for link-local-only
+operation.
</p>
</div>
<hr>
@@ -361,6 +396,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD_MANUAL "manual"
</pre>
<p>
+All necessary IPv4 configuration (addresses, prefix, DNS, etc) is specified
+in the setting's properties.
</p>
</div>
<hr>
@@ -369,6 +406,12 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD_SHARED "shared"
</pre>
<p>
+This connection specifies configuration that allows other computers to
+connect through it to the default network (usually the Internet). The
+connection's interface will be assigned a private address, and a DHCP server,
+caching DNS server, and Network Address Translation (NAT) functionality will
+be started on this connection's interface to allow other devices to connect
+through that interface to the default network.
</p>
</div>
<hr>
@@ -377,6 +420,7 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD_DISABLED "disabled"
</pre>
<p>
+This connection does not use or require IPv4 address and it should be disabled.
</p>
</div>
<hr>
@@ -392,12 +436,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip4-address-new"></a><h3>nm_ip4_address_new ()</h3>
<pre class="programlisting"><a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="returnvalue">NMIP4Address</span></a> * nm_ip4_address_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Creates and returns a new <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the new empty <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> object
</td>
</tr></tbody>
</table></div>
@@ -407,18 +452,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip4-address-dup"></a><h3>nm_ip4_address_dup ()</h3>
<pre class="programlisting"><a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="returnvalue">NMIP4Address</span></a> * nm_ip4_address_dup (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> *source</code></em>);</pre>
<p>
+Copies a given <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> object and returns the copy.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>source</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> object to copy
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the copy of the given <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> copy
</td>
</tr>
</tbody>
@@ -429,12 +475,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip4-address-ref"></a><h3>nm_ip4_address_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip4_address_ref (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> *address</code></em>);</pre>
<p>
+Increases the reference count of the object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a>
</td>
</tr></tbody>
</table></div>
@@ -444,12 +491,14 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip4-address-unref"></a><h3>nm_ip4_address_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip4_address_unref (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> *address</code></em>);</pre>
<p>
+Decreases the reference count of the object. If the reference count
+reaches zero, the object will be destroyed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a>
</td>
</tr></tbody>
</table></div>
@@ -460,23 +509,24 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_ip4_address_compare (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> *address</code></em>,
<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> *other</code></em>);</pre>
<p>
+Determines if two <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> objects contain the same values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>other</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> to compare <em class="parameter"><code>address</code></em> to.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the objects contain the same values, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if they do not.
</td>
</tr>
</tbody>
@@ -487,18 +537,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip4-address-get-address"></a><h3>nm_ip4_address_get_address ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_ip4_address_get_address (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> *address</code></em>);</pre>
<p>
+Gets the IPv4 address property of this address object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the IPv4 address in network byte order
</td>
</tr>
</tbody>
@@ -510,18 +561,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip4_address_set_address (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> *address</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> addr</code></em>);</pre>
<p>
+Sets the IPv4 address property of this object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>addr</code></em>Â:</span></p></td>
-<td>
+<td>the IPv4 address in network byte order
</td>
</tr>
</tbody>
@@ -532,18 +584,20 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip4-address-get-prefix"></a><h3>nm_ip4_address_get_prefix ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_ip4_address_get_prefix (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> *address</code></em>);</pre>
<p>
+Gets the IPv4 address prefix (ie "24" or "30" etc) property of this address
+object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the IPv4 address prefix
</td>
</tr>
</tbody>
@@ -555,18 +609,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip4_address_set_prefix (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> *address</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> prefix</code></em>);</pre>
<p>
+Sets the IPv4 address prefix.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>prefix</code></em>Â:</span></p></td>
-<td>
+<td>the address prefix, a number between 0 and 32 inclusive
</td>
</tr>
</tbody>
@@ -577,18 +632,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip4-address-get-gateway"></a><h3>nm_ip4_address_get_gateway ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_ip4_address_get_gateway (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> *address</code></em>);</pre>
<p>
+Gets the IPv4 default gateway property of this address object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the IPv4 gateway address in network byte order
</td>
</tr>
</tbody>
@@ -600,18 +656,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip4_address_set_gateway (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> *address</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> gateway</code></em>);</pre>
<p>
+Sets the IPv4 default gateway property of this address object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>gateway</code></em>Â:</span></p></td>
-<td>
+<td>the IPv4 default gateway in network byte order
</td>
</tr>
</tbody>
@@ -630,12 +687,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip4-route-new"></a><h3>nm_ip4_route_new ()</h3>
<pre class="programlisting"><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="returnvalue">NMIP4Route</span></a> * nm_ip4_route_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Creates and returns a new <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the new empty <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> object
</td>
</tr></tbody>
</table></div>
@@ -643,20 +701,21 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<hr>
<div class="refsect2" title="nm_ip4_route_dup ()">
<a name="nm-ip4-route-dup"></a><h3>nm_ip4_route_dup ()</h3>
-<pre class="programlisting"><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="returnvalue">NMIP4Route</span></a> * nm_ip4_route_dup (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *route</code></em>);</pre>
+<pre class="programlisting"><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="returnvalue">NMIP4Route</span></a> * nm_ip4_route_dup (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *source</code></em>);</pre>
<p>
+Copies a given <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> object and returns the copy.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
-<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td><p><span class="term"><em class="parameter"><code>source</code></em>Â:</span></p></td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> object to copy
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the copy of the given <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> copy
</td>
</tr>
</tbody>
@@ -667,12 +726,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip4-route-ref"></a><h3>nm_ip4_route_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip4_route_ref (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *route</code></em>);</pre>
<p>
+Increases the reference count of the object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a>
</td>
</tr></tbody>
</table></div>
@@ -682,12 +742,14 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip4-route-unref"></a><h3>nm_ip4_route_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip4_route_unref (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *route</code></em>);</pre>
<p>
+Decreases the reference count of the object. If the reference count
+reaches zero, the object will be destroyed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a>
</td>
</tr></tbody>
</table></div>
@@ -698,23 +760,24 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_ip4_route_compare (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *route</code></em>,
<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *other</code></em>);</pre>
<p>
+Determines if two <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> objects contain the same values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>other</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> to compare <em class="parameter"><code>route</code></em> to.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the objects contain the same values, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if they do not.
</td>
</tr>
</tbody>
@@ -725,18 +788,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip4-route-get-dest"></a><h3>nm_ip4_route_get_dest ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_ip4_route_get_dest (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *route</code></em>);</pre>
<p>
+Gets the IPv4 destination address property of this route object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the IPv4 address in network byte order
</td>
</tr>
</tbody>
@@ -748,18 +812,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip4_route_set_dest (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *route</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> dest</code></em>);</pre>
<p>
+Sets the IPv4 destination address property of this route object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest</code></em>Â:</span></p></td>
-<td>
+<td>the destination address in network byte order
</td>
</tr>
</tbody>
@@ -770,18 +835,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip4-route-get-prefix"></a><h3>nm_ip4_route_get_prefix ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_ip4_route_get_prefix (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *route</code></em>);</pre>
<p>
+Gets the IPv4 prefix (ie "24" or "30" etc) of this route.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the IPv4 prefix
</td>
</tr>
</tbody>
@@ -793,18 +859,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip4_route_set_prefix (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *route</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> prefix</code></em>);</pre>
<p>
+Sets the IPv4 prefix of this route.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>prefix</code></em>Â:</span></p></td>
-<td>
+<td>the prefix, a number between 0 and 32 inclusive
</td>
</tr>
</tbody>
@@ -815,18 +882,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip4-route-get-next-hop"></a><h3>nm_ip4_route_get_next_hop ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_ip4_route_get_next_hop (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *route</code></em>);</pre>
<p>
+Gets the IPv4 address of the next hop of this route.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the IPv4 address in network byte order
</td>
</tr>
</tbody>
@@ -838,18 +906,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip4_route_set_next_hop (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *route</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> next_hop</code></em>);</pre>
<p>
+Sets the IPv4 address of the next hop of this route.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>next_hop</code></em>Â:</span></p></td>
-<td>
+<td>the IPv4 address of the next hop in network byte order
</td>
</tr>
</tbody>
@@ -860,18 +929,20 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip4-route-get-metric"></a><h3>nm_ip4_route_get_metric ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_ip4_route_get_metric (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *route</code></em>);</pre>
<p>
+Gets the route metric property of this route object; lower values indicate
+"better" or more preferred routes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the route metric
</td>
</tr>
</tbody>
@@ -883,18 +954,20 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip4_route_set_metric (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *route</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> metric</code></em>);</pre>
<p>
+Sets the route metric property of this route object; lower values indicate
+"better" or more preferred routes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>metric</code></em>Â:</span></p></td>
-<td>
+<td>the route metric
</td>
</tr>
</tbody>
@@ -943,12 +1016,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip4-config-new"></a><h3>nm_setting_ip4_config_new ()</h3>
<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_ip4_config_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Creates a new <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> object with default values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the new empty <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> object
</td>
</tr></tbody>
</table></div>
@@ -957,19 +1031,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_ip4_config_get_method ()">
<a name="nm-setting-ip4-config-get-method"></a><h3>nm_setting_ip4_config_get_method ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_ip4_config_get_method (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--method" title='The "method" property'><span class="type">"method"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -979,19 +1051,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_ip4_config_get_num_dns ()">
<a name="nm-setting-ip4-config-get-num-dns"></a><h3>nm_setting_ip4_config_get_num_dns ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_ip4_config_get_num_dns (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the number of configured DNS servers
</td>
</tr>
</tbody>
@@ -1002,24 +1072,23 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip4-config-get-dns"></a><h3>nm_setting_ip4_config_get_dns ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_ip4_config_get_dns (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index number of the DNS server to return
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the IPv4 address (network byte order) of the DNS server at index
+<em class="parameter"><code>i</code></em>
</td>
</tr>
</tbody>
@@ -1031,23 +1100,25 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_ip4_config_add_dns (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> dns</code></em>);</pre>
<p>
+Adds a new DNS server to the setting.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dns</code></em>Â:</span></p></td>
-<td>
+<td>the IPv4 address (network byte order) of the DNS server to add
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the DNS server was added; <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the server was already
+known
</td>
</tr>
</tbody>
@@ -1059,18 +1130,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_ip4_config_remove_dns (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
<p>
+Removes the DNS server at index <em class="parameter"><code>i</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index number of the DNS server to remove
</td>
</tr>
</tbody>
@@ -1081,12 +1153,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip4-config-clear-dns"></a><h3>nm_setting_ip4_config_clear_dns ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_ip4_config_clear_dns (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre>
<p>
+Removes all configured DNS servers.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr></tbody>
</table></div>
@@ -1096,19 +1169,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip4-config-get-num-dns-searches"></a><h3>nm_setting_ip4_config_get_num_dns_searches ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_ip4_config_get_num_dns_searches
(<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the number of configured DNS search domains
</td>
</tr>
</tbody>
@@ -1120,24 +1191,22 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_ip4_config_get_dns_search
(<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index number of the DNS search domain to return
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the DNS search domain at index <em class="parameter"><code>i</code></em>
</td>
</tr>
</tbody>
@@ -1150,23 +1219,25 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
(<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *dns_search</code></em>);</pre>
<p>
+Adds a new DNS search domain to the setting.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dns_search</code></em>Â:</span></p></td>
-<td>
+<td>the search domain to add
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the DNS search domain was added; <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the search
+domain was already known
</td>
</tr>
</tbody>
@@ -1179,18 +1250,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
(<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
<p>
+Removes the DNS search domain at index <em class="parameter"><code>i</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index number of the DNS search domain
</td>
</tr>
</tbody>
@@ -1202,12 +1274,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_ip4_config_clear_dns_searches
(<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre>
<p>
+Removes all configured DNS search domains.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr></tbody>
</table></div>
@@ -1217,19 +1290,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip4-config-get-num-addresses"></a><h3>nm_setting_ip4_config_get_num_addresses ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_ip4_config_get_num_addresses
(<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the number of configured addresses
</td>
</tr>
</tbody>
@@ -1240,24 +1311,22 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip4-config-get-address"></a><h3>nm_setting_ip4_config_get_address ()</h3>
<pre class="programlisting"><a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="returnvalue">NMIP4Address</span></a> * nm_setting_ip4_config_get_address (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index number of the address to return
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the address at index <em class="parameter"><code>i</code></em>
</td>
</tr>
</tbody>
@@ -1269,23 +1338,26 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_ip4_config_add_address (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>,
<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> *address</code></em>);</pre>
<p>
+Adds a new IPv4 address and associated information to the setting. The
+given address is duplicated internally and is not changed by this function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the new address to add
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the address was added; <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the address was already
+known.
</td>
</tr>
</tbody>
@@ -1298,18 +1370,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
(<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
<p>
+Removes the address at index <em class="parameter"><code>i</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index number of the address to remove
</td>
</tr>
</tbody>
@@ -1321,12 +1394,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_ip4_config_clear_addresses
(<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre>
<p>
+Removes all configured addresses.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr></tbody>
</table></div>
@@ -1336,19 +1410,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip4-config-get-num-routes"></a><h3>nm_setting_ip4_config_get_num_routes ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_ip4_config_get_num_routes
(<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the number of configured routes
</td>
</tr>
</tbody>
@@ -1359,24 +1431,22 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip4-config-get-route"></a><h3>nm_setting_ip4_config_get_route ()</h3>
<pre class="programlisting"><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="returnvalue">NMIP4Route</span></a> * nm_setting_ip4_config_get_route (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index number of the route to return
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the route at index <em class="parameter"><code>i</code></em>
</td>
</tr>
</tbody>
@@ -1388,23 +1458,25 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_ip4_config_add_route (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>,
<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> *route</code></em>);</pre>
<p>
+Adds a new IPv4 route and associated information to the setting. The
+given route is duplicated internally and is not changed by this function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the route to add
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the route was added; <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the route was already known.
</td>
</tr>
</tbody>
@@ -1416,18 +1488,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_ip4_config_remove_route (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
<p>
+Removes the route at index <em class="parameter"><code>i</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index number of the route
</td>
</tr>
</tbody>
@@ -1438,12 +1511,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip4-config-clear-routes"></a><h3>nm_setting_ip4_config_clear_routes ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_ip4_config_clear_routes (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre>
<p>
+Removes all configured routes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr></tbody>
</table></div>
@@ -1454,18 +1528,21 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_ip4_config_get_ignore_auto_routes
(<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre>
<p>
+Returns the value contained in the <a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--ignore-auto-routes" title='The "ignore-auto-routes" property'><span class="type">"ignore-auto-routes"</span></a>
+property.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if automatically configured (ie via DHCP) routes should be
+ignored.
</td>
</tr>
</tbody>
@@ -1477,18 +1554,21 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_ip4_config_get_ignore_auto_dns
(<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre>
<p>
+Returns the value contained in the <a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--ignore-auto-dns" title='The "ignore-auto-dns" property'><span class="type">"ignore-auto-dns"</span></a>
+property.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if automatically configured (ie via DHCP) DNS information
+should be ignored.
</td>
</tr>
</tbody>
@@ -1500,18 +1580,21 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_ip4_config_get_dhcp_client_id
(<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre>
<p>
+Returns the value contained in the <a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--dhcp-client-id" title='The "dhcp-client-id" property'><span class="type">"dhcp-client-id"</span></a>
+property.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the configured Client ID to send to the DHCP server when requesting
+addresses via DHCP.
</td>
</tr>
</tbody>
@@ -1523,18 +1606,22 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_ip4_config_get_dhcp_send_hostname
(<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre>
<p>
+Returns the value contained in the <a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--dhcp-send-hostname" title='The "dhcp-send-hostname" property'><span class="type">"dhcp-send-hostname"</span></a>
+property.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if NetworkManager should send the machine hostname to the
+DHCP server when requesting addresses to allow the server to automatically
+update DNS information for this machine.
</td>
</tr>
</tbody>
@@ -1546,18 +1633,20 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_ip4_config_get_dhcp_hostname
(<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre>
<p>
+Returns the value contained in the <a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--dhcp-hostname" title='The "dhcp-hostname" property'><span class="type">"dhcp-hostname"</span></a>
+property.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the configured hostname to send to the DHCP server
</td>
</tr>
</tbody>
@@ -1569,18 +1658,21 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_ip4_config_get_never_default
(<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre>
<p>
+Returns the value contained in the <a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--never-default" title='The "never-default" property'><span class="type">"never-default"</span></a>
+property.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if this connection should never be the default connection
+for IPv4 addressing
</td>
</tr>
</tbody>
@@ -1591,18 +1683,21 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip4-config-get-may-fail"></a><h3>nm_setting_ip4_config_get_may_fail ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_ip4_config_get_may_fail (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre>
<p>
+Returns the value contained in the <a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--may-fail" title='The "may-fail" property'><span class="type">"may-fail"</span></a>
+property.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if this connection doesn't require IPv4 addressing to complete
+for the connection to succeed.
</td>
</tr>
</tbody>
diff --git a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingIP6Config.html b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingIP6Config.html
index 208d6f3..d8f2a05 100644
--- a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingIP6Config.html
+++ b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingIP6Config.html
@@ -35,13 +35,16 @@
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NMSettingIP6Config.top_of_page"></a>NMSettingIP6Config</span></h2>
-<p>NMSettingIP6Config</p>
+<p>NMSettingIP6Config â Describes IPv6 addressing, routing, and name service properties</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="NMSettingIP6Config.synopsis"></a><h2>Synopsis</h2>
-<pre class="synopsis">#define <a class="link" href="NMSettingIP6Config.html#NM-SETTING-IP6-CONFIG-SETTING-NAME:CAPS" title="NM_SETTING_IP6_CONFIG_SETTING_NAME">NM_SETTING_IP6_CONFIG_SETTING_NAME</a>
+<pre class="synopsis">
+#include <nm-setting-ip6-config.h>
+
+#define <a class="link" href="NMSettingIP6Config.html#NM-SETTING-IP6-CONFIG-SETTING-NAME:CAPS" title="NM_SETTING_IP6_CONFIG_SETTING_NAME">NM_SETTING_IP6_CONFIG_SETTING_NAME</a>
enum <a class="link" href="NMSettingIP6Config.html#NMSettingIP6ConfigError" title="enum NMSettingIP6ConfigError">NMSettingIP6ConfigError</a>;
#define <a class="link" href="NMSettingIP6Config.html#NM-TYPE-SETTING-IP6-CONFIG-ERROR:CAPS" title="NM_TYPE_SETTING_IP6_CONFIG_ERROR">NM_TYPE_SETTING_IP6_CONFIG_ERROR</a>
#define <a class="link" href="NMSettingIP6Config.html#NM-SETTING-IP6-CONFIG-ERROR:CAPS" title="NM_SETTING_IP6_CONFIG_ERROR">NM_SETTING_IP6_CONFIG_ERROR</a>
@@ -76,10 +79,10 @@ const struct <span class="returnvalue">in6_addr</span> * <a class="link" href="N
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> prefix</code></em>);
const struct <span class="returnvalue">in6_addr</span> * <a class="link" href="NMSettingIP6Config.html#nm-ip6-address-get-gateway" title="nm_ip6_address_get_gateway ()">nm_ip6_address_get_gateway</a> (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> *address</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NMSettingIP6Config.html#nm-ip6-address-set-gateway" title="nm_ip6_address_set_gateway ()">nm_ip6_address_set_gateway</a> (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> *address</code></em>,
- <em class="parameter"><code>const <span class="type">struct in6_addr</span> *gw</code></em>);
+ <em class="parameter"><code>const <span class="type">struct in6_addr</span> *gateway</code></em>);
typedef <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route">NMIP6Route</a>;
<a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="returnvalue">NMIP6Route</span></a> * <a class="link" href="NMSettingIP6Config.html#nm-ip6-route-new" title="nm_ip6_route_new ()">nm_ip6_route_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
-<a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="returnvalue">NMIP6Route</span></a> * <a class="link" href="NMSettingIP6Config.html#nm-ip6-route-dup" title="nm_ip6_route_dup ()">nm_ip6_route_dup</a> (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *route</code></em>);
+<a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="returnvalue">NMIP6Route</span></a> * <a class="link" href="NMSettingIP6Config.html#nm-ip6-route-dup" title="nm_ip6_route_dup ()">nm_ip6_route_dup</a> (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *source</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NMSettingIP6Config.html#nm-ip6-route-ref" title="nm_ip6_route_ref ()">nm_ip6_route_ref</a> (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *route</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NMSettingIP6Config.html#nm-ip6-route-unref" title="nm_ip6_route_unref ()">nm_ip6_route_unref</a> (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *route</code></em>);
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NMSettingIP6Config.html#nm-ip6-route-compare" title="nm_ip6_route_compare ()">nm_ip6_route_compare</a> (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *route</code></em>,
@@ -176,6 +179,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect1" title="Description">
<a name="NMSettingIP6Config.description"></a><h2>Description</h2>
<p>
+The <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes
+properties related to IPv6 addressing, routing, and Domain Name Service
</p>
</div>
<div class="refsect1" title="Details">
@@ -190,16 +195,40 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<hr>
<div class="refsect2" title="enum NMSettingIP6ConfigError">
<a name="NMSettingIP6ConfigError"></a><h3>enum NMSettingIP6ConfigError</h3>
-<pre class="programlisting">typedef enum
-{
+<pre class="programlisting">typedef enum {
NM_SETTING_IP6_CONFIG_ERROR_UNKNOWN = 0,
NM_SETTING_IP6_CONFIG_ERROR_INVALID_PROPERTY,
NM_SETTING_IP6_CONFIG_ERROR_MISSING_PROPERTY,
NM_SETTING_IP6_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD
} NMSettingIP6ConfigError;
</pre>
-<p>
-</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><a name="NM-SETTING-IP6-CONFIG-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_IP6_CONFIG_ERROR_UNKNOWN</code></span></p></td>
+<td>unknown or unclassified error
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-IP6-CONFIG-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_IP6_CONFIG_ERROR_INVALID_PROPERTY</code></span></p></td>
+<td>the property was invalid
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-IP6-CONFIG-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_IP6_CONFIG_ERROR_MISSING_PROPERTY</code></span></p></td>
+<td>the property was missing and is
+required
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-IP6-CONFIG-ERROR-NOT-ALLOWED-FOR-METHOD:CAPS"></a><span class="term"><code class="literal">NM_SETTING_IP6_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD</code></span></p></td>
+<td>the property's value is
+not valid with the given IPv6 method
+</td>
+</tr>
+</tbody>
+</table></div>
</div>
<hr>
<div class="refsect2" title="NM_TYPE_SETTING_IP6_CONFIG_ERROR">
@@ -222,12 +251,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip6-config-error-quark"></a><h3>nm_setting_ip6_config_error_quark ()</h3>
<pre class="programlisting"><a href="../glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_setting_ip6_config_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Registers an error quark for <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> if necessary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the error quark used for <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> errors.
</td>
</tr></tbody>
</table></div>
@@ -310,6 +340,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">#define NM_SETTING_IP6_CONFIG_METHOD_IGNORE "ignore"
</pre>
<p>
+IPv6 is not required or is handled by some other mechanism, and NetworkManager
+should not configure IPv6 for this connection.
</p>
</div>
<hr>
@@ -318,6 +350,9 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">#define NM_SETTING_IP6_CONFIG_METHOD_AUTO "auto"
</pre>
<p>
+IPv6 configuration should be automatically determined via a method appropriate
+for the hardware interface, ie router advertisements, DHCP, or PPP or some
+other device-specific manner.
</p>
</div>
<hr>
@@ -326,6 +361,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">#define NM_SETTING_IP6_CONFIG_METHOD_DHCP "dhcp"
</pre>
<p>
+IPv6 configuration should be automatically determined via DHCPv6 only and
+router advertisements should be ignored.
</p>
</div>
<hr>
@@ -334,6 +371,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">#define NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL "link-local"
</pre>
<p>
+IPv6 configuration should be automatically configured for link-local-only
+operation.
</p>
</div>
<hr>
@@ -342,6 +381,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">#define NM_SETTING_IP6_CONFIG_METHOD_MANUAL "manual"
</pre>
<p>
+All necessary IPv6 configuration (addresses, prefix, DNS, etc) is specified
+in the setting's properties.
</p>
</div>
<hr>
@@ -350,6 +391,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">#define NM_SETTING_IP6_CONFIG_METHOD_SHARED "shared"
</pre>
<p>
+This connection specifies configuration that allows other computers to
+connect through it to the default network (usually the Internet). The
+connection's interface will be assigned a private address, and router
+advertisements, a caching DNS server, and Network Address Translation (NAT)
+functionality will be started on this connection's interface to allow other
+devices to connect through that interface to the default network. (not yet
+supported for IPv6)
</p>
</div>
<hr>
@@ -365,12 +413,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip6-address-new"></a><h3>nm_ip6_address_new ()</h3>
<pre class="programlisting"><a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="returnvalue">NMIP6Address</span></a> * nm_ip6_address_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Creates and returns a new <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the new empty <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> object
</td>
</tr></tbody>
</table></div>
@@ -380,18 +429,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip6-address-dup"></a><h3>nm_ip6_address_dup ()</h3>
<pre class="programlisting"><a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="returnvalue">NMIP6Address</span></a> * nm_ip6_address_dup (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> *source</code></em>);</pre>
<p>
+Copies a given <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> object and returns the copy.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>source</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> object to copy
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the copy of the given <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> copy
</td>
</tr>
</tbody>
@@ -402,12 +452,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip6-address-ref"></a><h3>nm_ip6_address_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip6_address_ref (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> *address</code></em>);</pre>
<p>
+Increases the reference count of the object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a>
</td>
</tr></tbody>
</table></div>
@@ -417,12 +468,14 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip6-address-unref"></a><h3>nm_ip6_address_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip6_address_unref (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> *address</code></em>);</pre>
<p>
+Decreases the reference count of the object. If the reference count
+reaches zero, the object will be destroyed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a>
</td>
</tr></tbody>
</table></div>
@@ -433,23 +486,24 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_ip6_address_compare (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> *address</code></em>,
<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> *other</code></em>);</pre>
<p>
+Determines if two <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> objects contain the same values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>other</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> to compare <em class="parameter"><code>address</code></em> to.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the objects contain the same values, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if they do not.
</td>
</tr>
</tbody>
@@ -460,18 +514,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip6-address-get-address"></a><h3>nm_ip6_address_get_address ()</h3>
<pre class="programlisting">const struct <span class="returnvalue">in6_addr</span> * nm_ip6_address_get_address (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> *address</code></em>);</pre>
<p>
+Gets the IPv6 address property of this address object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the IPv6 address
</td>
</tr>
</tbody>
@@ -483,18 +538,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip6_address_set_address (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> *address</code></em>,
<em class="parameter"><code>const <span class="type">struct in6_addr</span> *addr</code></em>);</pre>
<p>
+Sets the IPv6 address property of this object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>addr</code></em>Â:</span></p></td>
-<td>
+<td>the IPv6 address
</td>
</tr>
</tbody>
@@ -505,18 +561,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip6-address-get-prefix"></a><h3>nm_ip6_address_get_prefix ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_ip6_address_get_prefix (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> *address</code></em>);</pre>
<p>
+Gets the IPv6 address prefix property of this address object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the IPv6 address prefix
</td>
</tr>
</tbody>
@@ -528,18 +585,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip6_address_set_prefix (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> *address</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> prefix</code></em>);</pre>
<p>
+Sets the IPv6 address prefix.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>prefix</code></em>Â:</span></p></td>
-<td>
+<td>the address prefix, a number between 0 and 128 inclusive
</td>
</tr>
</tbody>
@@ -550,18 +608,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip6-address-get-gateway"></a><h3>nm_ip6_address_get_gateway ()</h3>
<pre class="programlisting">const struct <span class="returnvalue">in6_addr</span> * nm_ip6_address_get_gateway (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> *address</code></em>);</pre>
<p>
+Gets the IPv6 default gateway property of this address object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the IPv6 gateway address
</td>
</tr>
</tbody>
@@ -571,20 +630,21 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_ip6_address_set_gateway ()">
<a name="nm-ip6-address-set-gateway"></a><h3>nm_ip6_address_set_gateway ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip6_address_set_gateway (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> *address</code></em>,
- <em class="parameter"><code>const <span class="type">struct in6_addr</span> *gw</code></em>);</pre>
+ <em class="parameter"><code>const <span class="type">struct in6_addr</span> *gateway</code></em>);</pre>
<p>
+Sets the IPv6 default gateway property of this address object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a>
</td>
</tr>
<tr>
-<td><p><span class="term"><em class="parameter"><code>gw</code></em>Â:</span></p></td>
-<td>
+<td><p><span class="term"><em class="parameter"><code>gateway</code></em>Â:</span></p></td>
+<td>the IPv6 default gateway
</td>
</tr>
</tbody>
@@ -603,12 +663,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip6-route-new"></a><h3>nm_ip6_route_new ()</h3>
<pre class="programlisting"><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="returnvalue">NMIP6Route</span></a> * nm_ip6_route_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Creates and returns a new <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the new empty <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> object
</td>
</tr></tbody>
</table></div>
@@ -616,20 +677,21 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<hr>
<div class="refsect2" title="nm_ip6_route_dup ()">
<a name="nm-ip6-route-dup"></a><h3>nm_ip6_route_dup ()</h3>
-<pre class="programlisting"><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="returnvalue">NMIP6Route</span></a> * nm_ip6_route_dup (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *route</code></em>);</pre>
+<pre class="programlisting"><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="returnvalue">NMIP6Route</span></a> * nm_ip6_route_dup (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *source</code></em>);</pre>
<p>
+Copies a given <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> object and returns the copy.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
-<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td><p><span class="term"><em class="parameter"><code>source</code></em>Â:</span></p></td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> object to copy
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the copy of the given <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> copy
</td>
</tr>
</tbody>
@@ -640,12 +702,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip6-route-ref"></a><h3>nm_ip6_route_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip6_route_ref (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *route</code></em>);</pre>
<p>
+Increases the reference count of the object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a>
</td>
</tr></tbody>
</table></div>
@@ -655,12 +718,14 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip6-route-unref"></a><h3>nm_ip6_route_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip6_route_unref (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *route</code></em>);</pre>
<p>
+Decreases the reference count of the object. If the reference count
+reaches zero, the object will be destroyed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a>
</td>
</tr></tbody>
</table></div>
@@ -671,23 +736,24 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_ip6_route_compare (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *route</code></em>,
<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *other</code></em>);</pre>
<p>
+Determines if two <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> objects contain the same values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>other</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> to compare <em class="parameter"><code>route</code></em> to.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the objects contain the same values, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if they do not.
</td>
</tr>
</tbody>
@@ -698,18 +764,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip6-route-get-dest"></a><h3>nm_ip6_route_get_dest ()</h3>
<pre class="programlisting">const struct <span class="returnvalue">in6_addr</span> * nm_ip6_route_get_dest (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *route</code></em>);</pre>
<p>
+Gets the IPv6 destination address property of this route object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the IPv6 address
</td>
</tr>
</tbody>
@@ -721,18 +788,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip6_route_set_dest (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *route</code></em>,
<em class="parameter"><code>const <span class="type">struct in6_addr</span> *dest</code></em>);</pre>
<p>
+Sets the IPv6 destination address property of this route object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest</code></em>Â:</span></p></td>
-<td>
+<td>the destination address
</td>
</tr>
</tbody>
@@ -743,18 +811,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip6-route-get-prefix"></a><h3>nm_ip6_route_get_prefix ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_ip6_route_get_prefix (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *route</code></em>);</pre>
<p>
+Gets the IPv6 prefix (ie "32" or "64" etc) of this route.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the IPv6 prefix
</td>
</tr>
</tbody>
@@ -766,18 +835,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip6_route_set_prefix (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *route</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> prefix</code></em>);</pre>
<p>
+Sets the IPv6 prefix of this route.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>prefix</code></em>Â:</span></p></td>
-<td>
+<td>the prefix, a number between 1 and 128 inclusive
</td>
</tr>
</tbody>
@@ -788,18 +858,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip6-route-get-next-hop"></a><h3>nm_ip6_route_get_next_hop ()</h3>
<pre class="programlisting">const struct <span class="returnvalue">in6_addr</span> * nm_ip6_route_get_next_hop (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *route</code></em>);</pre>
<p>
+Gets the IPv6 address of the next hop of this route.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the IPv6 address
</td>
</tr>
</tbody>
@@ -811,18 +882,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip6_route_set_next_hop (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *route</code></em>,
<em class="parameter"><code>const <span class="type">struct in6_addr</span> *next_hop</code></em>);</pre>
<p>
+Sets the IPv6 address of the next hop of this route.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>next_hop</code></em>Â:</span></p></td>
-<td>
+<td>the IPv6 address of the next hop
</td>
</tr>
</tbody>
@@ -833,18 +905,20 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-ip6-route-get-metric"></a><h3>nm_ip6_route_get_metric ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_ip6_route_get_metric (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *route</code></em>);</pre>
<p>
+Gets the route metric property of this route object; lower values indicate
+"better" or more preferred routes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the route metric
</td>
</tr>
</tbody>
@@ -856,18 +930,20 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_ip6_route_set_metric (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *route</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> metric</code></em>);</pre>
<p>
+Sets the route metric property of this route object; lower values indicate
+"better" or more preferred routes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>metric</code></em>Â:</span></p></td>
-<td>
+<td>the route metric
</td>
</tr>
</tbody>
@@ -916,12 +992,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip6-config-new"></a><h3>nm_setting_ip6_config_new ()</h3>
<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_ip6_config_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Creates a new <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> object with default values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the new empty <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> object
</td>
</tr></tbody>
</table></div>
@@ -930,19 +1007,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_ip6_config_get_method ()">
<a name="nm-setting-ip6-config-get-method"></a><h3>nm_setting_ip6_config_get_method ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_ip6_config_get_method (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingIP6Config.html#NMSettingIP6Config--method" title='The "method" property'><span class="type">"method"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -952,19 +1027,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_ip6_config_get_num_dns ()">
<a name="nm-setting-ip6-config-get-num-dns"></a><h3>nm_setting_ip6_config_get_num_dns ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_ip6_config_get_num_dns (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the number of configured DNS servers
</td>
</tr>
</tbody>
@@ -975,24 +1048,22 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip6-config-get-dns"></a><h3>nm_setting_ip6_config_get_dns ()</h3>
<pre class="programlisting">const struct <span class="returnvalue">in6_addr</span> * nm_setting_ip6_config_get_dns (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index number of the DNS server to return
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the IPv6 address of the DNS server at index <em class="parameter"><code>i</code></em>
</td>
</tr>
</tbody>
@@ -1004,23 +1075,25 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_ip6_config_add_dns (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>,
<em class="parameter"><code>const <span class="type">struct in6_addr</span> *dns</code></em>);</pre>
<p>
+Adds a new DNS server to the setting.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dns</code></em>Â:</span></p></td>
-<td>
+<td>the IPv6 address of the DNS server to add
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the DNS server was added; <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the server was already
+known
</td>
</tr>
</tbody>
@@ -1032,18 +1105,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_ip6_config_remove_dns (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
<p>
+Removes the DNS server at index <em class="parameter"><code>i</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index number of the DNS server to remove
</td>
</tr>
</tbody>
@@ -1054,12 +1128,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip6-config-clear-dns"></a><h3>nm_setting_ip6_config_clear_dns ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_ip6_config_clear_dns (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>);</pre>
<p>
+Removes all configured DNS servers.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr></tbody>
</table></div>
@@ -1069,19 +1144,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip6-config-get-num-dns-searches"></a><h3>nm_setting_ip6_config_get_num_dns_searches ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_ip6_config_get_num_dns_searches
(<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the number of configured DNS search domains
</td>
</tr>
</tbody>
@@ -1093,24 +1166,22 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_ip6_config_get_dns_search
(<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index number of the DNS search domain to return
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the DNS search domain at index <em class="parameter"><code>i</code></em>
</td>
</tr>
</tbody>
@@ -1123,23 +1194,25 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
(<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *dns_search</code></em>);</pre>
<p>
+Adds a new DNS search domain to the setting.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dns_search</code></em>Â:</span></p></td>
-<td>
+<td>the search domain to add
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the DNS search domain was added; <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the search
+domain was already known
</td>
</tr>
</tbody>
@@ -1152,18 +1225,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
(<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
<p>
+Removes the DNS search domain at index <em class="parameter"><code>i</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index number of the DNS search domain
</td>
</tr>
</tbody>
@@ -1175,12 +1249,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_ip6_config_clear_dns_searches
(<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>);</pre>
<p>
+Removes all configured DNS search domains.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr></tbody>
</table></div>
@@ -1190,19 +1265,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip6-config-get-num-addresses"></a><h3>nm_setting_ip6_config_get_num_addresses ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_ip6_config_get_num_addresses
(<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the number of configured addresses
</td>
</tr>
</tbody>
@@ -1213,24 +1286,22 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip6-config-get-address"></a><h3>nm_setting_ip6_config_get_address ()</h3>
<pre class="programlisting"><a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="returnvalue">NMIP6Address</span></a> * nm_setting_ip6_config_get_address (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index number of the address to return
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the address at index <em class="parameter"><code>i</code></em>
</td>
</tr>
</tbody>
@@ -1242,23 +1313,26 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_ip6_config_add_address (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>,
<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> *address</code></em>);</pre>
<p>
+Adds a new IPv6 address and associated information to the setting. The
+given address is duplicated internally and is not changed by this function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em>Â:</span></p></td>
-<td>
+<td>the new address to add
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the address was added; <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the address was already
+known.
</td>
</tr>
</tbody>
@@ -1271,18 +1345,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
(<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
<p>
+Removes the address at index <em class="parameter"><code>i</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index number of the address to remove
</td>
</tr>
</tbody>
@@ -1294,12 +1369,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_ip6_config_clear_addresses
(<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>);</pre>
<p>
+Removes all configured addresses.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr></tbody>
</table></div>
@@ -1309,19 +1385,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip6-config-get-num-routes"></a><h3>nm_setting_ip6_config_get_num_routes ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_ip6_config_get_num_routes
(<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the number of configured routes
</td>
</tr>
</tbody>
@@ -1332,24 +1406,22 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip6-config-get-route"></a><h3>nm_setting_ip6_config_get_route ()</h3>
<pre class="programlisting"><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="returnvalue">NMIP6Route</span></a> * nm_setting_ip6_config_get_route (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index number of the route to return
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the route at index <em class="parameter"><code>i</code></em>
</td>
</tr>
</tbody>
@@ -1361,23 +1433,25 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_ip6_config_add_route (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>,
<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> *route</code></em>);</pre>
<p>
+Adds a new IPv6 route and associated information to the setting. The
+given route is duplicated internally and is not changed by this function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>route</code></em>Â:</span></p></td>
-<td>
+<td>the route to add
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the route was added; <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the route was already known.
</td>
</tr>
</tbody>
@@ -1389,18 +1463,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_ip6_config_remove_route (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
<p>
+Removes the route at index <em class="parameter"><code>i</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index number of the route
</td>
</tr>
</tbody>
@@ -1411,12 +1486,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip6-config-clear-routes"></a><h3>nm_setting_ip6_config_clear_routes ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_ip6_config_clear_routes (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>);</pre>
<p>
+Removes all configured routes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr></tbody>
</table></div>
@@ -1427,18 +1503,21 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_ip6_config_get_ignore_auto_routes
(<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>);</pre>
<p>
+Returns the value contained in the <a class="link" href="NMSettingIP6Config.html#NMSettingIP6Config--ignore-auto-routes" title='The "ignore-auto-routes" property'><span class="type">"ignore-auto-routes"</span></a>
+property.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if automatically configured (ie via DHCP) routes should be
+ignored.
</td>
</tr>
</tbody>
@@ -1450,18 +1529,21 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_ip6_config_get_ignore_auto_dns
(<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>);</pre>
<p>
+Returns the value contained in the <a class="link" href="NMSettingIP6Config.html#NMSettingIP6Config--ignore-auto-dns" title='The "ignore-auto-dns" property'><span class="type">"ignore-auto-dns"</span></a>
+property.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if automatically configured (ie via DHCP or router
+advertisements) DNS information should be ignored.
</td>
</tr>
</tbody>
@@ -1473,18 +1555,21 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_ip6_config_get_never_default
(<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>);</pre>
<p>
+Returns the value contained in the <a class="link" href="NMSettingIP6Config.html#NMSettingIP6Config--never-default" title='The "never-default" property'><span class="type">"never-default"</span></a>
+property.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if this connection should never be the default connection
+for IPv6 addressing
</td>
</tr>
</tbody>
@@ -1495,18 +1580,21 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-ip6-config-get-may-fail"></a><h3>nm_setting_ip6_config_get_may_fail ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_ip6_config_get_may_fail (<em class="parameter"><code><a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> *setting</code></em>);</pre>
<p>
+Returns the value contained in the <a class="link" href="NMSettingIP6Config.html#NMSettingIP6Config--may-fail" title='The "may-fail" property'><span class="type">"may-fail"</span></a>
+property.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if this connection doesn't require IPv6 addressing to complete
+for the connection to succeed.
</td>
</tr>
</tbody>
diff --git a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingPPP.html b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingPPP.html
index 26be884..37802fb 100644
--- a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingPPP.html
+++ b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingPPP.html
@@ -35,13 +35,17 @@
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NMSettingPPP.top_of_page"></a>NMSettingPPP</span></h2>
-<p>NMSettingPPP</p>
+<p>NMSettingPPP â Describes connection properties for devices/networks
+that require PPP to deliver IP capability</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="NMSettingPPP.synopsis"></a><h2>Synopsis</h2>
-<pre class="synopsis">#define <a class="link" href="NMSettingPPP.html#NM-SETTING-PPP-SETTING-NAME:CAPS" title="NM_SETTING_PPP_SETTING_NAME">NM_SETTING_PPP_SETTING_NAME</a>
+<pre class="synopsis">
+#include <nm-setting-ppp.h>
+
+#define <a class="link" href="NMSettingPPP.html#NM-SETTING-PPP-SETTING-NAME:CAPS" title="NM_SETTING_PPP_SETTING_NAME">NM_SETTING_PPP_SETTING_NAME</a>
enum <a class="link" href="NMSettingPPP.html#NMSettingPPPError" title="enum NMSettingPPPError">NMSettingPPPError</a>;
#define <a class="link" href="NMSettingPPP.html#NM-TYPE-SETTING-PPP-ERROR:CAPS" title="NM_TYPE_SETTING_PPP_ERROR">NM_TYPE_SETTING_PPP_ERROR</a>
#define <a class="link" href="NMSettingPPP.html#NM-SETTING-PPP-ERROR:CAPS" title="NM_SETTING_PPP_ERROR">NM_SETTING_PPP_ERROR</a>
@@ -123,6 +127,9 @@ enum <a class="link" href="NMSettingPPP.html#NMSettingPPPError" t
<div class="refsect1" title="Description">
<a name="NMSettingPPP.description"></a><h2>Description</h2>
<p>
+The <a class="link" href="NMSettingPPP.html" title="NMSettingPPP"><span class="type">NMSettingPPP</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes properties
+necessary for connection to networks that require PPP transport, like PPPoE
+cable and DSL modems and some mobile broadband devices.
</p>
</div>
<div class="refsect1" title="Details">
@@ -137,16 +144,40 @@ enum <a class="link" href="NMSettingPPP.html#NMSettingPPPError" t
<hr>
<div class="refsect2" title="enum NMSettingPPPError">
<a name="NMSettingPPPError"></a><h3>enum NMSettingPPPError</h3>
-<pre class="programlisting">typedef enum
-{
+<pre class="programlisting">typedef enum {
NM_SETTING_PPP_ERROR_UNKNOWN = 0,
NM_SETTING_PPP_ERROR_INVALID_PROPERTY,
NM_SETTING_PPP_ERROR_MISSING_PROPERTY,
NM_SETTING_PPP_ERROR_REQUIRE_MPPE_NOT_ALLOWED
} NMSettingPPPError;
</pre>
-<p>
-</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><a name="NM-SETTING-PPP-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_PPP_ERROR_UNKNOWN</code></span></p></td>
+<td>unknown or unclassified error
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-PPP-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_PPP_ERROR_INVALID_PROPERTY</code></span></p></td>
+<td>the property was invalid
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-PPP-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_PPP_ERROR_MISSING_PROPERTY</code></span></p></td>
+<td>the property was missing and is
+required
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-PPP-ERROR-REQUIRE-MPPE-NOT-ALLOWED:CAPS"></a><span class="term"><code class="literal">NM_SETTING_PPP_ERROR_REQUIRE_MPPE_NOT_ALLOWED</code></span></p></td>
+<td>requiring MPPE is not compatible
+with other setting configuration parameters
+</td>
+</tr>
+</tbody>
+</table></div>
</div>
<hr>
<div class="refsect2" title="NM_TYPE_SETTING_PPP_ERROR">
@@ -169,12 +200,13 @@ enum <a class="link" href="NMSettingPPP.html#NMSettingPPPError" t
<a name="nm-setting-ppp-error-quark"></a><h3>nm_setting_ppp_error_quark ()</h3>
<pre class="programlisting"><a href="../glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_setting_ppp_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Registers an error quark for <a class="link" href="NMSettingPPP.html" title="NMSettingPPP"><span class="type">NMSettingPPP</span></a> if necessary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the error quark used for <a class="link" href="NMSettingPPP.html" title="NMSettingPPP"><span class="type">NMSettingPPP</span></a> errors.
</td>
</tr></tbody>
</table></div>
@@ -366,12 +398,13 @@ enum <a class="link" href="NMSettingPPP.html#NMSettingPPPError" t
<a name="nm-setting-ppp-new"></a><h3>nm_setting_ppp_new ()</h3>
<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_ppp_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Creates a new <a class="link" href="NMSettingPPP.html" title="NMSettingPPP"><span class="type">NMSettingPPP</span></a> object with default values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the new empty <a class="link" href="NMSettingPPP.html" title="NMSettingPPP"><span class="type">NMSettingPPP</span></a> object
</td>
</tr></tbody>
</table></div>
diff --git a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingPPPOE.html b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingPPPOE.html
index 90e8356..ea48744 100644
--- a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingPPPOE.html
+++ b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingPPPOE.html
@@ -35,13 +35,16 @@
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NMSettingPPPOE.top_of_page"></a>NMSettingPPPOE</span></h2>
-<p>NMSettingPPPOE</p>
+<p>NMSettingPPPOE â Describes PPPoE connection properties</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="NMSettingPPPOE.synopsis"></a><h2>Synopsis</h2>
-<pre class="synopsis">#define <a class="link" href="NMSettingPPPOE.html#NM-SETTING-PPPOE-SETTING-NAME:CAPS" title="NM_SETTING_PPPOE_SETTING_NAME">NM_SETTING_PPPOE_SETTING_NAME</a>
+<pre class="synopsis">
+#include <nm-setting-pppoe.h>
+
+#define <a class="link" href="NMSettingPPPOE.html#NM-SETTING-PPPOE-SETTING-NAME:CAPS" title="NM_SETTING_PPPOE_SETTING_NAME">NM_SETTING_PPPOE_SETTING_NAME</a>
enum <a class="link" href="NMSettingPPPOE.html#NMSettingPPPOEError" title="enum NMSettingPPPOEError">NMSettingPPPOEError</a>;
#define <a class="link" href="NMSettingPPPOE.html#NM-TYPE-SETTING-PPPOE-ERROR:CAPS" title="NM_TYPE_SETTING_PPPOE_ERROR">NM_TYPE_SETTING_PPPOE_ERROR</a>
#define <a class="link" href="NMSettingPPPOE.html#NM-SETTING-PPPOE-ERROR:CAPS" title="NM_SETTING_PPPOE_ERROR">NM_SETTING_PPPOE_ERROR</a>
@@ -77,6 +80,9 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect1" title="Description">
<a name="NMSettingPPPOE.description"></a><h2>Description</h2>
<p>
+The <a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes
+properties necessary for connection to networks that require PPPoE connections
+to provide IP transport, for example cable or DSL modems.
</p>
</div>
<div class="refsect1" title="Details">
@@ -91,16 +97,40 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<hr>
<div class="refsect2" title="enum NMSettingPPPOEError">
<a name="NMSettingPPPOEError"></a><h3>enum NMSettingPPPOEError</h3>
-<pre class="programlisting">typedef enum
-{
+<pre class="programlisting">typedef enum {
NM_SETTING_PPPOE_ERROR_UNKNOWN = 0,
NM_SETTING_PPPOE_ERROR_INVALID_PROPERTY,
NM_SETTING_PPPOE_ERROR_MISSING_PROPERTY,
NM_SETTING_PPPOE_ERROR_MISSING_PPP_SETTING
} NMSettingPPPOEError;
</pre>
-<p>
-</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><a name="NM-SETTING-PPPOE-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_PPPOE_ERROR_UNKNOWN</code></span></p></td>
+<td>unknown or unclassified error
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-PPPOE-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_PPPOE_ERROR_INVALID_PROPERTY</code></span></p></td>
+<td>the property was invalid
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-PPPOE-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_PPPOE_ERROR_MISSING_PROPERTY</code></span></p></td>
+<td>the property was missing and is
+required
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-PPPOE-ERROR-MISSING-PPP-SETTING:CAPS"></a><span class="term"><code class="literal">NM_SETTING_PPPOE_ERROR_MISSING_PPP_SETTING</code></span></p></td>
+<td>the connection
+did not contain a required PPP setting for PPP related options
+</td>
+</tr>
+</tbody>
+</table></div>
</div>
<hr>
<div class="refsect2" title="NM_TYPE_SETTING_PPPOE_ERROR">
@@ -123,12 +153,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-pppoe-error-quark"></a><h3>nm_setting_pppoe_error_quark ()</h3>
<pre class="programlisting"><a href="../glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_setting_pppoe_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Registers an error quark for <a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> if necessary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the error quark used for <a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> errors.
</td>
</tr></tbody>
</table></div>
@@ -200,12 +231,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-pppoe-new"></a><h3>nm_setting_pppoe_new ()</h3>
<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_pppoe_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Creates a new <a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> object with default values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the new empty <a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> object
</td>
</tr></tbody>
</table></div>
@@ -214,19 +246,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_pppoe_get_service ()">
<a name="nm-setting-pppoe-get-service"></a><h3>nm_setting_pppoe_get_service ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_pppoe_get_service (<em class="parameter"><code><a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingPPPOE.html#NMSettingPPPOE--password" title='The "password" property'><span class="type">"password"</span></a> property of the setting
</td>
</tr>
</tbody>
diff --git a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingSerial.html b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingSerial.html
index e977a2e..2a3f78c 100644
--- a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingSerial.html
+++ b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingSerial.html
@@ -35,13 +35,17 @@
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NMSettingSerial.top_of_page"></a>NMSettingSerial</span></h2>
-<p>NMSettingSerial</p>
+<p>NMSettingSerial â Describes connection properties for devices that use
+serial communications</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="NMSettingSerial.synopsis"></a><h2>Synopsis</h2>
-<pre class="synopsis">#define <a class="link" href="NMSettingSerial.html#NM-SETTING-SERIAL-SETTING-NAME:CAPS" title="NM_SETTING_SERIAL_SETTING_NAME">NM_SETTING_SERIAL_SETTING_NAME</a>
+<pre class="synopsis">
+#include <nm-setting-serial.h>
+
+#define <a class="link" href="NMSettingSerial.html#NM-SETTING-SERIAL-SETTING-NAME:CAPS" title="NM_SETTING_SERIAL_SETTING_NAME">NM_SETTING_SERIAL_SETTING_NAME</a>
enum <a class="link" href="NMSettingSerial.html#NMSettingSerialError" title="enum NMSettingSerialError">NMSettingSerialError</a>;
#define <a class="link" href="NMSettingSerial.html#NM-TYPE-SETTING-SERIAL-ERROR:CAPS" title="NM_TYPE_SETTING_SERIAL_ERROR">NM_TYPE_SETTING_SERIAL_ERROR</a>
#define <a class="link" href="NMSettingSerial.html#NM-SETTING-SERIAL-ERROR:CAPS" title="NM_SETTING_SERIAL_ERROR">NM_SETTING_SERIAL_ERROR</a>
@@ -83,6 +87,9 @@ enum <a class="link" href="NMSettingSerial.html#NMSettingSerialEr
<div class="refsect1" title="Description">
<a name="NMSettingSerial.description"></a><h2>Description</h2>
<p>
+The <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes
+properties necessary for connections that may use serial communications,
+such as mobile broadband or analog telephone connections.
</p>
</div>
<div class="refsect1" title="Details">
@@ -97,16 +104,40 @@ enum <a class="link" href="NMSettingSerial.html#NMSettingSerialEr
<hr>
<div class="refsect2" title="enum NMSettingSerialError">
<a name="NMSettingSerialError"></a><h3>enum NMSettingSerialError</h3>
-<pre class="programlisting">typedef enum
-{
+<pre class="programlisting">typedef enum {
NM_SETTING_SERIAL_ERROR_UNKNOWN = 0,
NM_SETTING_SERIAL_ERROR_INVALID_PROPERTY,
NM_SETTING_SERIAL_ERROR_MISSING_PROPERTY,
NM_SETTING_SERIAL_ERROR_MISSING_PPP_SETTING
} NMSettingSerialError;
</pre>
-<p>
-</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><a name="NM-SETTING-SERIAL-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_SERIAL_ERROR_UNKNOWN</code></span></p></td>
+<td>unknown or unclassified error
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-SERIAL-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_SERIAL_ERROR_INVALID_PROPERTY</code></span></p></td>
+<td>the property was invalid
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-SERIAL-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_SERIAL_ERROR_MISSING_PROPERTY</code></span></p></td>
+<td>the property was missing and is
+required
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-SERIAL-ERROR-MISSING-PPP-SETTING:CAPS"></a><span class="term"><code class="literal">NM_SETTING_SERIAL_ERROR_MISSING_PPP_SETTING</code></span></p></td>
+<td>one of the properties of the
+setting requires the connection to contain an <a class="link" href="NMSettingPPP.html" title="NMSettingPPP"><span class="type">NMSettingPPP</span></a> setting
+</td>
+</tr>
+</tbody>
+</table></div>
</div>
<hr>
<div class="refsect2" title="NM_TYPE_SETTING_SERIAL_ERROR">
@@ -129,12 +160,13 @@ enum <a class="link" href="NMSettingSerial.html#NMSettingSerialEr
<a name="nm-setting-serial-error-quark"></a><h3>nm_setting_serial_error_quark ()</h3>
<pre class="programlisting"><a href="../glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_setting_serial_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Registers an error quark for <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> if necessary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the error quark used for <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> errors.
</td>
</tr></tbody>
</table></div>
@@ -222,12 +254,13 @@ enum <a class="link" href="NMSettingSerial.html#NMSettingSerialEr
<a name="nm-setting-serial-new"></a><h3>nm_setting_serial_new ()</h3>
<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_serial_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Creates a new <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> object with default values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the new empty <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> object
</td>
</tr></tbody>
</table></div>
@@ -236,19 +269,17 @@ enum <a class="link" href="NMSettingSerial.html#NMSettingSerialEr
<div class="refsect2" title="nm_setting_serial_get_baud ()">
<a name="nm-setting-serial-get-baud"></a><h3>nm_setting_serial_get_baud ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> nm_setting_serial_get_baud (<em class="parameter"><code><a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingSerial.html#NMSettingSerial--baud" title='The "baud" property'><span class="type">"baud"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -258,19 +289,17 @@ enum <a class="link" href="NMSettingSerial.html#NMSettingSerialEr
<div class="refsect2" title="nm_setting_serial_get_bits ()">
<a name="nm-setting-serial-get-bits"></a><h3>nm_setting_serial_get_bits ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> nm_setting_serial_get_bits (<em class="parameter"><code><a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingSerial.html#NMSettingSerial--bits" title='The "bits" property'><span class="type">"bits"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -280,19 +309,17 @@ enum <a class="link" href="NMSettingSerial.html#NMSettingSerialEr
<div class="refsect2" title="nm_setting_serial_get_parity ()">
<a name="nm-setting-serial-get-parity"></a><h3>nm_setting_serial_get_parity ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> nm_setting_serial_get_parity (<em class="parameter"><code><a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingSerial.html#NMSettingSerial--parity" title='The "parity" property'><span class="type">"parity"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -302,19 +329,17 @@ enum <a class="link" href="NMSettingSerial.html#NMSettingSerialEr
<div class="refsect2" title="nm_setting_serial_get_stopbits ()">
<a name="nm-setting-serial-get-stopbits"></a><h3>nm_setting_serial_get_stopbits ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> nm_setting_serial_get_stopbits (<em class="parameter"><code><a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingSerial.html#NMSettingSerial--stopbits" title='The "stopbits" property'><span class="type">"stopbits"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -324,19 +349,17 @@ enum <a class="link" href="NMSettingSerial.html#NMSettingSerialEr
<div class="refsect2" title="nm_setting_serial_get_send_delay ()">
<a name="nm-setting-serial-get-send-delay"></a><h3>nm_setting_serial_get_send_delay ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> nm_setting_serial_get_send_delay (<em class="parameter"><code><a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingSerial.html#NMSettingSerial--send-delay" title='The "send-delay" property'><span class="type">"send-delay"</span></a> property of the setting
</td>
</tr>
</tbody>
diff --git a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingVPN.html b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingVPN.html
index 385ad6c..5c917a6 100644
--- a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingVPN.html
+++ b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingVPN.html
@@ -35,13 +35,16 @@
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NMSettingVPN.top_of_page"></a>NMSettingVPN</span></h2>
-<p>NMSettingVPN</p>
+<p>NMSettingVPN â Describes connection properties for Virtual Private Networks</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="NMSettingVPN.synopsis"></a><h2>Synopsis</h2>
-<pre class="synopsis">#define <a class="link" href="NMSettingVPN.html#NM-SETTING-VPN-SETTING-NAME:CAPS" title="NM_SETTING_VPN_SETTING_NAME">NM_SETTING_VPN_SETTING_NAME</a>
+<pre class="synopsis">
+#include <nm-setting-vpn.h>
+
+#define <a class="link" href="NMSettingVPN.html#NM-SETTING-VPN-SETTING-NAME:CAPS" title="NM_SETTING_VPN_SETTING_NAME">NM_SETTING_VPN_SETTING_NAME</a>
enum <a class="link" href="NMSettingVPN.html#NMSettingVpnError" title="enum NMSettingVpnError">NMSettingVpnError</a>;
#define <a class="link" href="NMSettingVPN.html#NM-TYPE-SETTING-VPN-ERROR:CAPS" title="NM_TYPE_SETTING_VPN_ERROR">NM_TYPE_SETTING_VPN_ERROR</a>
#define <a class="link" href="NMSettingVPN.html#NM-SETTING-VPN-ERROR:CAPS" title="NM_SETTING_VPN_ERROR">NM_SETTING_VPN_ERROR</a>
@@ -101,6 +104,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect1" title="Description">
<a name="NMSettingVPN.description"></a><h2>Description</h2>
<p>
+The <a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes properties
+necessary for connection to Virtual Private Networks. NetworkManager uses
+a plugin architecture to allow easier use of new VPN types, and this
+setting abstracts the configuration for those plugins. Since the configuration
+options are only known to the VPN plugins themselves, the VPN configuration
+options are stored as key/value pairs of strings rather than GObject
+properties.
</p>
</div>
<div class="refsect1" title="Details">
@@ -115,15 +125,33 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<hr>
<div class="refsect2" title="enum NMSettingVpnError">
<a name="NMSettingVpnError"></a><h3>enum NMSettingVpnError</h3>
-<pre class="programlisting">typedef enum
-{
+<pre class="programlisting">typedef enum {
NM_SETTING_VPN_ERROR_UNKNOWN = 0,
NM_SETTING_VPN_ERROR_INVALID_PROPERTY,
NM_SETTING_VPN_ERROR_MISSING_PROPERTY,
} NMSettingVpnError;
</pre>
-<p>
-</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><a name="NM-SETTING-VPN-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_VPN_ERROR_UNKNOWN</code></span></p></td>
+<td>unknown or unclassified error
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-VPN-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_VPN_ERROR_INVALID_PROPERTY</code></span></p></td>
+<td>the property was invalid
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-VPN-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_VPN_ERROR_MISSING_PROPERTY</code></span></p></td>
+<td>the property was missing and is
+required
+</td>
+</tr>
+</tbody>
+</table></div>
</div>
<hr>
<div class="refsect2" title="NM_TYPE_SETTING_VPN_ERROR">
@@ -146,12 +174,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-vpn-error-quark"></a><h3>nm_setting_vpn_error_quark ()</h3>
<pre class="programlisting"><a href="../glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_setting_vpn_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Registers an error quark for <a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> if necessary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the error quark used for <a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> errors.
</td>
</tr></tbody>
</table></div>
@@ -217,24 +246,23 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> (*VPNIterFunc) (<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *value</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em>Â:</span></p></td>
-<td>
+<td>the name of the data or secret item
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em>Â:</span></p></td>
-<td>
+<td>the value of the data or secret item
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>Â:</span></p></td>
-<td>
+<td>User data passed to <a class="link" href="NMSettingVPN.html#nm-setting-vpn-foreach-data-item" title="nm_setting_vpn_foreach_data_item ()"><code class="function">nm_setting_vpn_foreach_data_item()</code></a> or
+<a class="link" href="NMSettingVPN.html#nm-setting-vpn-foreach-secret" title="nm_setting_vpn_foreach_secret ()"><code class="function">nm_setting_vpn_foreach_secret()</code></a>
</td>
</tr>
</tbody>
@@ -260,12 +288,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-vpn-new"></a><h3>nm_setting_vpn_new ()</h3>
<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_vpn_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Creates a new <a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> object with default values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the new empty <a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> object
</td>
</tr></tbody>
</table></div>
@@ -275,18 +304,20 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-vpn-get-service-type"></a><h3>nm_setting_vpn_get_service_type ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_vpn_get_service_type (<em class="parameter"><code><a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> *setting</code></em>);</pre>
<p>
+Returns the service name of the VPN, which identifies the specific VPN
+plugin that should be used to connect to this VPN.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the VPN plugin's service name
</td>
</tr>
</tbody>
@@ -296,19 +327,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_vpn_get_user_name ()">
<a name="nm-setting-vpn-get-user-name"></a><h3>nm_setting_vpn_get_user_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_vpn_get_user_name (<em class="parameter"><code><a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingVPN.html#NMSettingVPN--user-name" title='The "user-name" property'><span class="type">"user-name"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -321,23 +350,26 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *item</code></em>);</pre>
<p>
+Establishes a relationship between <em class="parameter"><code>key</code></em> and <em class="parameter"><code>item</code></em> internally in the
+setting which may be retrieved later. Should not be used to store passwords
+or other secrets, which is what <a class="link" href="NMSettingVPN.html#nm-setting-vpn-add-secret" title="nm_setting_vpn_add_secret ()"><code class="function">nm_setting_vpn_add_secret()</code></a> is for.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em>Â:</span></p></td>
-<td>
+<td>a name that uniquely identifies the given value <em class="parameter"><code>item</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em>Â:</span></p></td>
-<td>
+<td>the value to be referenced by <em class="parameter"><code>key</code></em>
</td>
</tr>
</tbody>
@@ -349,23 +381,25 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_vpn_get_data_item (<em class="parameter"><code><a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> *setting</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>);</pre>
<p>
+Retrieves the data item of a key/value relationship previously established
+by <a class="link" href="NMSettingVPN.html#nm-setting-vpn-add-data-item" title="nm_setting_vpn_add_data_item ()"><code class="function">nm_setting_vpn_add_data_item()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em>Â:</span></p></td>
-<td>
+<td>the name of the data item to retrieve
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the data item, if any
</td>
</tr>
</tbody>
@@ -377,18 +411,20 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_vpn_remove_data_item (<em class="parameter"><code><a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> *setting</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>);</pre>
<p>
+Deletes a key/value relationship previously established by
+<a class="link" href="NMSettingVPN.html#nm-setting-vpn-add-data-item" title="nm_setting_vpn_add_data_item ()"><code class="function">nm_setting_vpn_add_data_item()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em>Â:</span></p></td>
-<td>
+<td>the name of the data item to remove
</td>
</tr>
</tbody>
@@ -430,23 +466,25 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *secret</code></em>);</pre>
<p>
+Establishes a relationship between <em class="parameter"><code>key</code></em> and <em class="parameter"><code>secret</code></em> internally in the
+setting which may be retrieved later.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em>Â:</span></p></td>
-<td>
+<td>a name that uniquely identifies the given secret <em class="parameter"><code>secret</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>secret</code></em>Â:</span></p></td>
-<td>
+<td>the secret to be referenced by <em class="parameter"><code>key</code></em>
</td>
</tr>
</tbody>
@@ -458,23 +496,25 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_vpn_get_secret (<em class="parameter"><code><a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> *setting</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>);</pre>
<p>
+Retrieves the secret of a key/value relationship previously established
+by <a class="link" href="NMSettingVPN.html#nm-setting-vpn-add-secret" title="nm_setting_vpn_add_secret ()"><code class="function">nm_setting_vpn_add_secret()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em>Â:</span></p></td>
-<td>
+<td>the name of the secret to retrieve
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the secret, if any
</td>
</tr>
</tbody>
@@ -486,18 +526,20 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_vpn_remove_secret (<em class="parameter"><code><a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> *setting</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>);</pre>
<p>
+Deletes a key/value relationship previously established by
+<a class="link" href="NMSettingVPN.html#nm-setting-vpn-add-secret" title="nm_setting_vpn_add_secret ()"><code class="function">nm_setting_vpn_add_secret()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em>Â:</span></p></td>
-<td>
+<td>the name of the secret to remove
</td>
</tr>
</tbody>
diff --git a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingWired.html b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingWired.html
index e765383..0e33168 100644
--- a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingWired.html
+++ b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingWired.html
@@ -35,13 +35,16 @@
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NMSettingWired.top_of_page"></a>NMSettingWired</span></h2>
-<p>NMSettingWired</p>
+<p>NMSettingWired â Describes connection properties for Ethernet-based networks</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="NMSettingWired.synopsis"></a><h2>Synopsis</h2>
-<pre class="synopsis">#define <a class="link" href="NMSettingWired.html#NM-SETTING-WIRED-SETTING-NAME:CAPS" title="NM_SETTING_WIRED_SETTING_NAME">NM_SETTING_WIRED_SETTING_NAME</a>
+<pre class="synopsis">
+#include <nm-setting-wired.h>
+
+#define <a class="link" href="NMSettingWired.html#NM-SETTING-WIRED-SETTING-NAME:CAPS" title="NM_SETTING_WIRED_SETTING_NAME">NM_SETTING_WIRED_SETTING_NAME</a>
enum <a class="link" href="NMSettingWired.html#NMSettingWiredError" title="enum NMSettingWiredError">NMSettingWiredError</a>;
#define <a class="link" href="NMSettingWired.html#NM-TYPE-SETTING-WIRED-ERROR:CAPS" title="NM_TYPE_SETTING_WIRED_ERROR">NM_TYPE_SETTING_WIRED_ERROR</a>
#define <a class="link" href="NMSettingWired.html#NM-SETTING-WIRED-ERROR:CAPS" title="NM_SETTING_WIRED_ERROR">NM_SETTING_WIRED_ERROR</a>
@@ -52,6 +55,7 @@ enum <a class="link" href="NMSettingWired.html#NMSettingWiredErro
#define <a class="link" href="NMSettingWired.html#NM-SETTING-WIRED-AUTO-NEGOTIATE:CAPS" title="NM_SETTING_WIRED_AUTO_NEGOTIATE">NM_SETTING_WIRED_AUTO_NEGOTIATE</a>
#define <a class="link" href="NMSettingWired.html#NM-SETTING-WIRED-MAC-ADDRESS:CAPS" title="NM_SETTING_WIRED_MAC_ADDRESS">NM_SETTING_WIRED_MAC_ADDRESS</a>
#define <a class="link" href="NMSettingWired.html#NM-SETTING-WIRED-CLONED-MAC-ADDRESS:CAPS" title="NM_SETTING_WIRED_CLONED_MAC_ADDRESS">NM_SETTING_WIRED_CLONED_MAC_ADDRESS</a>
+#define <a class="link" href="NMSettingWired.html#NM-SETTING-WIRED-MAC-ADDRESS-BLACKLIST:CAPS" title="NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST">NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST</a>
#define <a class="link" href="NMSettingWired.html#NM-SETTING-WIRED-MTU:CAPS" title="NM_SETTING_WIRED_MTU">NM_SETTING_WIRED_MTU</a>
#define <a class="link" href="NMSettingWired.html#NM-SETTING-WIRED-S390-SUBCHANNELS:CAPS" title="NM_SETTING_WIRED_S390_SUBCHANNELS">NM_SETTING_WIRED_S390_SUBCHANNELS</a>
#define <a class="link" href="NMSettingWired.html#NM-SETTING-WIRED-S390-NETTYPE:CAPS" title="NM_SETTING_WIRED_S390_NETTYPE">NM_SETTING_WIRED_S390_NETTYPE</a>
@@ -67,6 +71,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
const <a href="../glib/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> * <a class="link" href="NMSettingWired.html#nm-setting-wired-get-mac-address" title="nm_setting_wired_get_mac_address ()">nm_setting_wired_get_mac_address</a> (<em class="parameter"><code><a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> *setting</code></em>);
const <a href="../glib/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> * <a class="link" href="NMSettingWired.html#nm-setting-wired-get-cloned-mac-address" title="nm_setting_wired_get_cloned_mac_address ()">nm_setting_wired_get_cloned_mac_address</a>
(<em class="parameter"><code><a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> *setting</code></em>);
+const <a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * <a class="link" href="NMSettingWired.html#nm-setting-wired-get-mac-address-blacklist" title="nm_setting_wired_get_mac_address_blacklist ()">nm_setting_wired_get_mac_address_blacklist</a>
+ (<em class="parameter"><code><a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> *setting</code></em>);
<a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="NMSettingWired.html#nm-setting-wired-get-mtu" title="nm_setting_wired_get_mtu ()">nm_setting_wired_get_mtu</a> (<em class="parameter"><code><a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> *setting</code></em>);
const <a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * <a class="link" href="NMSettingWired.html#nm-setting-wired-get-s390-subchannels" title="nm_setting_wired_get_s390_subchannels ()">nm_setting_wired_get_s390_subchannels</a>
(<em class="parameter"><code><a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> *setting</code></em>);
@@ -102,6 +108,7 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
"<a class="link" href="NMSettingWired.html#NMSettingWired--cloned-mac-address" title='The "cloned-mac-address" property'>cloned-mac-address</a>" <span class="type">GArray_guchar_</span>* : Read / Write
"<a class="link" href="NMSettingWired.html#NMSettingWired--duplex" title='The "duplex" property'>duplex</a>" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a class="link" href="NMSettingWired.html#NMSettingWired--mac-address" title='The "mac-address" property'>mac-address</a>" <span class="type">GArray_guchar_</span>* : Read / Write
+ "<a class="link" href="NMSettingWired.html#NMSettingWired--mac-address-blacklist" title='The "mac-address-blacklist" property'>mac-address-blacklist</a>" <span class="type">GSList_gchararray_</span>* : Read / Write
"<a class="link" href="NMSettingWired.html#NMSettingWired--mtu" title='The "mtu" property'>mtu</a>" <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct
"<a class="link" href="NMSettingWired.html#NMSettingWired--port" title='The "port" property'>port</a>" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a class="link" href="NMSettingWired.html#NMSettingWired--s390-nettype" title='The "s390-nettype" property'>s390-nettype</a>" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
@@ -113,6 +120,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect1" title="Description">
<a name="NMSettingWired.description"></a><h2>Description</h2>
<p>
+The <a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes properties
+necessary for connection to Ethernet networks.
</p>
</div>
<div class="refsect1" title="Details">
@@ -127,15 +136,33 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<hr>
<div class="refsect2" title="enum NMSettingWiredError">
<a name="NMSettingWiredError"></a><h3>enum NMSettingWiredError</h3>
-<pre class="programlisting">typedef enum
-{
+<pre class="programlisting">typedef enum {
NM_SETTING_WIRED_ERROR_UNKNOWN = 0,
NM_SETTING_WIRED_ERROR_INVALID_PROPERTY,
NM_SETTING_WIRED_ERROR_MISSING_PROPERTY
} NMSettingWiredError;
</pre>
-<p>
-</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><a name="NM-SETTING-WIRED-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_WIRED_ERROR_UNKNOWN</code></span></p></td>
+<td>unknown or unclassified error
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-WIRED-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_WIRED_ERROR_INVALID_PROPERTY</code></span></p></td>
+<td>the property was invalid
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-WIRED-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_WIRED_ERROR_MISSING_PROPERTY</code></span></p></td>
+<td>the property was missing and is
+required
+</td>
+</tr>
+</tbody>
+</table></div>
</div>
<hr>
<div class="refsect2" title="NM_TYPE_SETTING_WIRED_ERROR">
@@ -158,12 +185,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wired-error-quark"></a><h3>nm_setting_wired_error_quark ()</h3>
<pre class="programlisting"><a href="../glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_setting_wired_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Registers an error quark for <a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> if necessary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the error quark used for <a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> errors.
</td>
</tr></tbody>
</table></div>
@@ -217,6 +245,14 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
</p>
</div>
<hr>
+<div class="refsect2" title="NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST">
+<a name="NM-SETTING-WIRED-MAC-ADDRESS-BLACKLIST:CAPS"></a><h3>NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST</h3>
+<pre class="programlisting">#define NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
+</pre>
+<p>
+</p>
+</div>
+<hr>
<div class="refsect2" title="NM_SETTING_WIRED_MTU">
<a name="NM-SETTING-WIRED-MTU:CAPS"></a><h3>NM_SETTING_WIRED_MTU</h3>
<pre class="programlisting">#define NM_SETTING_WIRED_MTU "mtu"
@@ -291,12 +327,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wired-new"></a><h3>nm_setting_wired_new ()</h3>
<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_wired_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Creates a new <a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> object with default values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the new empty <a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> object
</td>
</tr></tbody>
</table></div>
@@ -305,19 +342,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_wired_get_port ()">
<a name="nm-setting-wired-get-port"></a><h3>nm_setting_wired_get_port ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_wired_get_port (<em class="parameter"><code><a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWired.html#NMSettingWired--port" title='The "port" property'><span class="type">"port"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -327,19 +362,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_wired_get_speed ()">
<a name="nm-setting-wired-get-speed"></a><h3>nm_setting_wired_get_speed ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_wired_get_speed (<em class="parameter"><code><a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWired.html#NMSettingWired--speed" title='The "speed" property'><span class="type">"speed"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -349,19 +382,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_wired_get_duplex ()">
<a name="nm-setting-wired-get-duplex"></a><h3>nm_setting_wired_get_duplex ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_wired_get_duplex (<em class="parameter"><code><a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWired.html#NMSettingWired--duplex" title='The "duplex" property'><span class="type">"duplex"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -371,19 +402,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_wired_get_auto_negotiate ()">
<a name="nm-setting-wired-get-auto-negotiate"></a><h3>nm_setting_wired_get_auto_negotiate ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_wired_get_auto_negotiate (<em class="parameter"><code><a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWired.html#NMSettingWired--auto-negotiate" title='The "auto-negotiate" property'><span class="type">"auto-negotiate"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -393,19 +422,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_wired_get_mac_address ()">
<a name="nm-setting-wired-get-mac-address"></a><h3>nm_setting_wired_get_mac_address ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> * nm_setting_wired_get_mac_address (<em class="parameter"><code><a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWired.html#NMSettingWired--mac-address" title='The "mac-address" property'><span class="type">"mac-address"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -416,19 +443,39 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wired-get-cloned-mac-address"></a><h3>nm_setting_wired_get_cloned_mac_address ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> * nm_setting_wired_get_cloned_mac_address
(<em class="parameter"><code><a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWired.html#NMSettingWired--cloned-mac-address" title='The "cloned-mac-address" property'><span class="type">"cloned-mac-address"</span></a> property of the setting
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2" title="nm_setting_wired_get_mac_address_blacklist ()">
+<a name="nm-setting-wired-get-mac-address-blacklist"></a><h3>nm_setting_wired_get_mac_address_blacklist ()</h3>
+<pre class="programlisting">const <a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * nm_setting_wired_get_mac_address_blacklist
+ (<em class="parameter"><code><a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> *setting</code></em>);</pre>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
+<td>the <a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
+<td> the <a class="link" href="NMSettingWired.html#NMSettingWired--mac-address-blacklist" title='The "mac-address-blacklist" property'><span class="type">"mac-address-blacklist"</span></a>
+property of the setting
</td>
</tr>
</tbody>
@@ -438,19 +485,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_wired_get_mtu ()">
<a name="nm-setting-wired-get-mtu"></a><h3>nm_setting_wired_get_mtu ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_wired_get_mtu (<em class="parameter"><code><a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWired.html#NMSettingWired--mtu" title='The "mtu" property'><span class="type">"mtu"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -476,8 +521,8 @@ conjunction with that device.
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td> a <a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> of strings, each specifying one subchannel the
-s390 device uses to communicate to the host.
+<td> <a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> of strings, each specifying one
+subchannel the s390 device uses to communicate to the host.
</td>
</tr>
</tbody>
@@ -563,14 +608,14 @@ such as during option iteration.
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out_key</code></em>Â:</span></p></td>
-<td>on return, the key name of the s390 specific option; this value is
-owned by the setting and should not be modified
+<td>on return, the key name of the s390 specific option; this
+value is owned by the setting and should not be modified
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out_value</code></em>Â:</span></p></td>
-<td>on return, the value of the key of the s390 specific option; this
-value is owned by the setting and should not be modified
+<td>on return, the value of the key of the s390 specific
+option; this value is owned by the setting and should not be modified
</td>
</tr>
<tr>
@@ -716,6 +761,17 @@ of the device (i.e. MAC spoofing).
</p>
</div>
<hr>
+<div class="refsect2" title='The "mac-address-blacklist" property'>
+<a name="NMSettingWired--mac-address-blacklist"></a><h3>The <code class="literal">"mac-address-blacklist"</code> property</h3>
+<pre class="programlisting"> "mac-address-blacklist" <span class="type">GSList_gchararray_</span>* : Read / Write</pre>
+<p>
+If specified, this connection will never apply to the ethernet device
+whose permanent MAC address matches an address in the list. Each
+MAC address is in the standard hex-digits-and-colons notation
+(00:11:22:33:44:55).
+</p>
+</div>
+<hr>
<div class="refsect2" title='The "mtu" property'>
<a name="NMSettingWired--mtu"></a><h3>The <code class="literal">"mtu"</code> property</h3>
<pre class="programlisting"> "mtu" <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct</pre>
diff --git a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingWireless.html b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingWireless.html
index eb0e3c4..7f302d9 100644
--- a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingWireless.html
+++ b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingWireless.html
@@ -35,13 +35,16 @@
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NMSettingWireless.top_of_page"></a>NMSettingWireless</span></h2>
-<p>NMSettingWireless</p>
+<p>NMSettingWireless â Describes connection properties for 802.11 WiFi networks</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="NMSettingWireless.synopsis"></a><h2>Synopsis</h2>
-<pre class="synopsis">#define <a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-SETTING-NAME:CAPS" title="NM_SETTING_WIRELESS_SETTING_NAME">NM_SETTING_WIRELESS_SETTING_NAME</a>
+<pre class="synopsis">
+#include <nm-setting-wireless.h>
+
+#define <a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-SETTING-NAME:CAPS" title="NM_SETTING_WIRELESS_SETTING_NAME">NM_SETTING_WIRELESS_SETTING_NAME</a>
enum <a class="link" href="NMSettingWireless.html#NMSettingWirelessError" title="enum NMSettingWirelessError">NMSettingWirelessError</a>;
#define <a class="link" href="NMSettingWireless.html#NM-TYPE-SETTING-WIRELESS-ERROR:CAPS" title="NM_TYPE_SETTING_WIRELESS_ERROR">NM_TYPE_SETTING_WIRELESS_ERROR</a>
#define <a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-ERROR:CAPS" title="NM_SETTING_WIRELESS_ERROR">NM_SETTING_WIRELESS_ERROR</a>
@@ -55,9 +58,12 @@ enum <a class="link" href="NMSettingWireless.html#NMSettingWirele
#define <a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-TX-POWER:CAPS" title="NM_SETTING_WIRELESS_TX_POWER">NM_SETTING_WIRELESS_TX_POWER</a>
#define <a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-MAC-ADDRESS:CAPS" title="NM_SETTING_WIRELESS_MAC_ADDRESS">NM_SETTING_WIRELESS_MAC_ADDRESS</a>
#define <a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-CLONED-MAC-ADDRESS:CAPS" title="NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS">NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS</a>
+#define <a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-MAC-ADDRESS-BLACKLIST:CAPS" title="NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST">NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST</a>
#define <a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-MTU:CAPS" title="NM_SETTING_WIRELESS_MTU">NM_SETTING_WIRELESS_MTU</a>
#define <a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-SEEN-BSSIDS:CAPS" title="NM_SETTING_WIRELESS_SEEN_BSSIDS">NM_SETTING_WIRELESS_SEEN_BSSIDS</a>
#define <a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-SEC:CAPS" title="NM_SETTING_WIRELESS_SEC">NM_SETTING_WIRELESS_SEC</a>
+#define <a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-MODE-ADHOC:CAPS" title="NM_SETTING_WIRELESS_MODE_ADHOC">NM_SETTING_WIRELESS_MODE_ADHOC</a>
+#define <a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-MODE-INFRA:CAPS" title="NM_SETTING_WIRELESS_MODE_INFRA">NM_SETTING_WIRELESS_MODE_INFRA</a>
<a class="link" href="NMSettingWireless.html#NMSettingWireless-struct" title="NMSettingWireless">NMSettingWireless</a>;
<a class="link" href="NMSettingWireless.html#NMSettingWirelessClass" title="NMSettingWirelessClass">NMSettingWirelessClass</a>;
<a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="NMSettingWireless.html#nm-setting-wireless-get-type" title="nm_setting_wireless_get_type ()">nm_setting_wireless_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
@@ -72,6 +78,8 @@ const <a href="../glib/glib-Byte-Arrays.html#GByteArray"><span class="returnvalu
const <a href="../glib/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> * <a class="link" href="NMSettingWireless.html#nm-setting-wireless-get-mac-address" title="nm_setting_wireless_get_mac_address ()">nm_setting_wireless_get_mac_address</a> (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>);
const <a href="../glib/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> * <a class="link" href="NMSettingWireless.html#nm-setting-wireless-get-cloned-mac-address" title="nm_setting_wireless_get_cloned_mac_address ()">nm_setting_wireless_get_cloned_mac_address</a>
(<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>);
+const <a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * <a class="link" href="NMSettingWireless.html#nm-setting-wireless-get-mac-address-blacklist" title="nm_setting_wireless_get_mac_address_blacklist ()">nm_setting_wireless_get_mac_address_blacklist</a>
+ (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>);
<a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="NMSettingWireless.html#nm-setting-wireless-get-mtu" title="nm_setting_wireless_get_mtu ()">nm_setting_wireless_get_mtu</a> (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="NMSettingWireless.html#nm-setting-wireless-get-security" title="nm_setting_wireless_get_security ()">nm_setting_wireless_get_security</a> (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>);
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NMSettingWireless.html#nm-setting-wireless-add-seen-bssid" title="nm_setting_wireless_add_seen_bssid ()">nm_setting_wireless_add_seen_bssid</a> (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>,
@@ -105,6 +113,7 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
"<a class="link" href="NMSettingWireless.html#NMSettingWireless--channel" title='The "channel" property'>channel</a>" <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct
"<a class="link" href="NMSettingWireless.html#NMSettingWireless--cloned-mac-address" title='The "cloned-mac-address" property'>cloned-mac-address</a>" <span class="type">GArray_guchar_</span>* : Read / Write
"<a class="link" href="NMSettingWireless.html#NMSettingWireless--mac-address" title='The "mac-address" property'>mac-address</a>" <span class="type">GArray_guchar_</span>* : Read / Write
+ "<a class="link" href="NMSettingWireless.html#NMSettingWireless--mac-address-blacklist" title='The "mac-address-blacklist" property'>mac-address-blacklist</a>" <span class="type">GSList_gchararray_</span>* : Read / Write
"<a class="link" href="NMSettingWireless.html#NMSettingWireless--mode" title='The "mode" property'>mode</a>" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a class="link" href="NMSettingWireless.html#NMSettingWireless--mtu" title='The "mtu" property'>mtu</a>" <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct
"<a class="link" href="NMSettingWireless.html#NMSettingWireless--rate" title='The "rate" property'>rate</a>" <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct
@@ -117,6 +126,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect1" title="Description">
<a name="NMSettingWireless.description"></a><h2>Description</h2>
<p>
+The <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes properties
+necessary for connection to 802.11 WiFi networks.
</p>
</div>
<div class="refsect1" title="Details">
@@ -131,8 +142,7 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<hr>
<div class="refsect2" title="enum NMSettingWirelessError">
<a name="NMSettingWirelessError"></a><h3>enum NMSettingWirelessError</h3>
-<pre class="programlisting">typedef enum
-{
+<pre class="programlisting">typedef enum {
NM_SETTING_WIRELESS_ERROR_UNKNOWN = 0,
NM_SETTING_WIRELESS_ERROR_INVALID_PROPERTY,
NM_SETTING_WIRELESS_ERROR_MISSING_PROPERTY,
@@ -140,8 +150,39 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
NM_SETTING_WIRELESS_ERROR_CHANNEL_REQUIRES_BAND
} NMSettingWirelessError;
</pre>
-<p>
-</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><a name="NM-SETTING-WIRELESS-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_WIRELESS_ERROR_UNKNOWN</code></span></p></td>
+<td>unknown or unclassified error
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-WIRELESS-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_WIRELESS_ERROR_INVALID_PROPERTY</code></span></p></td>
+<td>the property was invalid
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-WIRELESS-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_WIRELESS_ERROR_MISSING_PROPERTY</code></span></p></td>
+<td>the property was missing and is
+required
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-WIRELESS-ERROR-MISSING-SECURITY-SETTING:CAPS"></a><span class="term"><code class="literal">NM_SETTING_WIRELESS_ERROR_MISSING_SECURITY_SETTING</code></span></p></td>
+<td>property values require
+the presence of an <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> object in the connection
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-WIRELESS-ERROR-CHANNEL-REQUIRES-BAND:CAPS"></a><span class="term"><code class="literal">NM_SETTING_WIRELESS_ERROR_CHANNEL_REQUIRES_BAND</code></span></p></td>
+<td>the property channel was
+set to a value that requires the <a class="link" href="NMSettingWireless.html#NMSettingWireless--band" title='The "band" property'><span class="type">"band"</span></a> property to be set
+</td>
+</tr>
+</tbody>
+</table></div>
</div>
<hr>
<div class="refsect2" title="NM_TYPE_SETTING_WIRELESS_ERROR">
@@ -164,12 +205,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wireless-error-quark"></a><h3>nm_setting_wireless_error_quark ()</h3>
<pre class="programlisting"><a href="../glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_setting_wireless_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Registers an error quark for <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> if necessary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the error quark used for <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> errors.
</td>
</tr></tbody>
</table></div>
@@ -247,6 +289,14 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
</p>
</div>
<hr>
+<div class="refsect2" title="NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST">
+<a name="NM-SETTING-WIRELESS-MAC-ADDRESS-BLACKLIST:CAPS"></a><h3>NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST</h3>
+<pre class="programlisting">#define NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
+</pre>
+<p>
+</p>
+</div>
+<hr>
<div class="refsect2" title="NM_SETTING_WIRELESS_MTU">
<a name="NM-SETTING-WIRELESS-MTU:CAPS"></a><h3>NM_SETTING_WIRELESS_MTU</h3>
<pre class="programlisting">#define NM_SETTING_WIRELESS_MTU "mtu"
@@ -271,6 +321,25 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
</p>
</div>
<hr>
+<div class="refsect2" title="NM_SETTING_WIRELESS_MODE_ADHOC">
+<a name="NM-SETTING-WIRELESS-MODE-ADHOC:CAPS"></a><h3>NM_SETTING_WIRELESS_MODE_ADHOC</h3>
+<pre class="programlisting">#define NM_SETTING_WIRELESS_MODE_ADHOC "adhoc"
+</pre>
+<p>
+Indicates Ad-Hoc mode where no access point is expected to be present.
+</p>
+</div>
+<hr>
+<div class="refsect2" title="NM_SETTING_WIRELESS_MODE_INFRA">
+<a name="NM-SETTING-WIRELESS-MODE-INFRA:CAPS"></a><h3>NM_SETTING_WIRELESS_MODE_INFRA</h3>
+<pre class="programlisting">#define NM_SETTING_WIRELESS_MODE_INFRA "infrastructure"
+</pre>
+<p>
+Indicates infrastructure mode where an access point is expected to be present
+for this connection.
+</p>
+</div>
+<hr>
<div class="refsect2" title="NMSettingWireless">
<a name="NMSettingWireless-struct"></a><h3>NMSettingWireless</h3>
<pre class="programlisting">typedef struct _NMSettingWireless NMSettingWireless;</pre>
@@ -313,12 +382,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wireless-new"></a><h3>nm_setting_wireless_new ()</h3>
<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_wireless_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Creates a new <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> object with default values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the new empty <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> object
</td>
</tr></tbody>
</table></div>
@@ -327,19 +397,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_wireless_get_ssid ()">
<a name="nm-setting-wireless-get-ssid"></a><h3>nm_setting_wireless_get_ssid ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> * nm_setting_wireless_get_ssid (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--ssid" title='The "ssid" property'><span class="type">"ssid"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -349,19 +417,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_wireless_get_mode ()">
<a name="nm-setting-wireless-get-mode"></a><h3>nm_setting_wireless_get_mode ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_wireless_get_mode (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--mode" title='The "mode" property'><span class="type">"mode"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -371,19 +437,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_wireless_get_band ()">
<a name="nm-setting-wireless-get-band"></a><h3>nm_setting_wireless_get_band ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_wireless_get_band (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--band" title='The "band" property'><span class="type">"band"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -393,19 +457,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_wireless_get_channel ()">
<a name="nm-setting-wireless-get-channel"></a><h3>nm_setting_wireless_get_channel ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_wireless_get_channel (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--channel" title='The "channel" property'><span class="type">"channel"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -415,19 +477,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_wireless_get_bssid ()">
<a name="nm-setting-wireless-get-bssid"></a><h3>nm_setting_wireless_get_bssid ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> * nm_setting_wireless_get_bssid (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--bssid" title='The "bssid" property'><span class="type">"bssid"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -437,19 +497,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_wireless_get_rate ()">
<a name="nm-setting-wireless-get-rate"></a><h3>nm_setting_wireless_get_rate ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_wireless_get_rate (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--rate" title='The "rate" property'><span class="type">"rate"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -459,19 +517,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_wireless_get_tx_power ()">
<a name="nm-setting-wireless-get-tx-power"></a><h3>nm_setting_wireless_get_tx_power ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_wireless_get_tx_power (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--tx-power" title='The "tx-power" property'><span class="type">"tx-power"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -481,19 +537,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_wireless_get_mac_address ()">
<a name="nm-setting-wireless-get-mac-address"></a><h3>nm_setting_wireless_get_mac_address ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> * nm_setting_wireless_get_mac_address (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--mac-address" title='The "mac-address" property'><span class="type">"mac-address"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -504,19 +558,38 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wireless-get-cloned-mac-address"></a><h3>nm_setting_wireless_get_cloned_mac_address ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> * nm_setting_wireless_get_cloned_mac_address
(<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--cloned-mac-address" title='The "cloned-mac-address" property'><span class="type">"cloned-mac-address"</span></a> property of the setting
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2" title="nm_setting_wireless_get_mac_address_blacklist ()">
+<a name="nm-setting-wireless-get-mac-address-blacklist"></a><h3>nm_setting_wireless_get_mac_address_blacklist ()</h3>
+<pre class="programlisting">const <a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * nm_setting_wireless_get_mac_address_blacklist
+ (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>);</pre>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
+<td>the <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
+<td> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--mac-address-blacklist" title='The "mac-address-blacklist" property'><span class="type">"mac-address-blacklist"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -526,19 +599,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_wireless_get_mtu ()">
<a name="nm-setting-wireless-get-mtu"></a><h3>nm_setting_wireless_get_mtu ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_wireless_get_mtu (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--mtu" title='The "mtu" property'><span class="type">"mtu"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -548,19 +619,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect2" title="nm_setting_wireless_get_security ()">
<a name="nm-setting-wireless-get-security"></a><h3>nm_setting_wireless_get_security ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_wireless_get_security (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--security" title='The "security" property'><span class="type">"security"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -572,23 +641,26 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_wireless_add_seen_bssid (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *bssid</code></em>);</pre>
<p>
+Adds a new WiFi AP's BSSID to the previously seen BSSID list of the setting.
+NetworkManager tracks previously seen BSSIDs internally so this function
+no longer has much use.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bssid</code></em>Â:</span></p></td>
-<td>
+<td>the new BSSID to add to the list
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>bssid</code></em> was already known, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not
</td>
</tr>
</tbody>
@@ -599,19 +671,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wireless-get-num-seen-bssids"></a><h3>nm_setting_wireless_get_num_seen_bssids ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_wireless_get_num_seen_bssids
(<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the number of BSSIDs in the previously seen BSSID list
</td>
</tr>
</tbody>
@@ -622,24 +692,22 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wireless-get-seen-bssid"></a><h3>nm_setting_wireless_get_seen_bssid ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_wireless_get_seen_bssid (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index of a BSSID in the previously seen BSSID list
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the BSSID at index <em class="parameter"><code>i</code></em>
</td>
</tr>
</tbody>
@@ -656,43 +724,52 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> ap_rsn</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> ap_mode</code></em>);</pre>
<p>
+Given a <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> and an optional <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>,
+determine if the configuration given by the settings is compatible with
+the security of an access point using that access point's capability flags
+and mode. Useful for clients that wish to filter a set of connections
+against a set of access points and determine which connections are
+compatible with which access points.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>s_wireless</code></em>Â:</span></p></td>
-<td>
+<td>a <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>s_wireless_sec</code></em>Â:</span></p></td>
-<td>
+<td>a <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ap_flags</code></em>Â:</span></p></td>
-<td>
+<td>the <code class="literal">NM80211ApFlags</code> of the given access point
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ap_wpa</code></em>Â:</span></p></td>
-<td>
+<td>the <code class="literal">NM80211ApSecurityFlags</code> of the given access point's WPA
+capabilities
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ap_rsn</code></em>Â:</span></p></td>
-<td>
+<td>the <code class="literal">NM80211ApSecurityFlags</code> of the given access point's WPA2/RSN
+capabilities
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ap_mode</code></em>Â:</span></p></td>
-<td>
+<td>the 802.11 mode of the AP, either Ad-Hoc or Infrastructure
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the given settings are compatible with the access point's
+security flags and mode, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if they are not.
</td>
</tr>
</tbody>
@@ -757,6 +834,17 @@ of the device (i.e. MAC spoofing).
</p>
</div>
<hr>
+<div class="refsect2" title='The "mac-address-blacklist" property'>
+<a name="NMSettingWireless--mac-address-blacklist"></a><h3>The <code class="literal">"mac-address-blacklist"</code> property</h3>
+<pre class="programlisting"> "mac-address-blacklist" <span class="type">GSList_gchararray_</span>* : Read / Write</pre>
+<p>
+If specified, this connection will never apply to the WiFi device
+whose permanent MAC address matches an address in the list. Each
+MAC address is in the standard hex-digits-and-colons notation.
+(00:11:22:33:44:55).
+</p>
+</div>
+<hr>
<div class="refsect2" title='The "mode" property'>
<a name="NMSettingWireless--mode"></a><h3>The <code class="literal">"mode"</code> property</h3>
<pre class="programlisting"> "mode" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
@@ -806,11 +894,8 @@ the connection contains a valid 802-11-wireless-security setting.
<p>
A list of BSSIDs (each BSSID formatted as a MAC address like
'00:11:22:33:44:55') that have been detected as part of the WiFI network.
-The settings service will usually populate this property by periodically
-asking NetworkManager what the device's current AP is while connected
-to the network (or monitoring the device's 'active-ap' property) and
-adding the current AP'sBSSID to this list. This list helps NetworkManager
-find hidden APs by matching up scan results with the BSSIDs in this list.
+NetworkManager internally tracks previously seen BSSIDs so this property
+is no longer of much use.
</p>
</div>
<hr>
diff --git a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingWirelessSecurity.html b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingWirelessSecurity.html
index 143f145..3b2943a 100644
--- a/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingWirelessSecurity.html
+++ b/projects.gnome.org/NetworkManager/developers/libnm-util/08/NMSettingWirelessSecurity.html
@@ -35,13 +35,17 @@
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NMSettingWirelessSecurity.top_of_page"></a>NMSettingWirelessSecurity</span></h2>
-<p>NMSettingWirelessSecurity</p>
+<p>NMSettingWirelessSecurity â Describes connection properties for WiFi networks that
+use WEP, LEAP, WPA or WPA2/RSN security</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="NMSettingWirelessSecurity.synopsis"></a><h2>Synopsis</h2>
-<pre class="synopsis">#define <a class="link" href="NMSettingWirelessSecurity.html#NM-SETTING-WIRELESS-SECURITY-SETTING-NAME:CAPS" title="NM_SETTING_WIRELESS_SECURITY_SETTING_NAME">NM_SETTING_WIRELESS_SECURITY_SETTING_NAME</a>
+<pre class="synopsis">
+#include <nm-setting-wireless-security.h>
+
+#define <a class="link" href="NMSettingWirelessSecurity.html#NM-SETTING-WIRELESS-SECURITY-SETTING-NAME:CAPS" title="NM_SETTING_WIRELESS_SECURITY_SETTING_NAME">NM_SETTING_WIRELESS_SECURITY_SETTING_NAME</a>
enum <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurityError" title="enum NMSettingWirelessSecurityError">NMSettingWirelessSecurityError</a>;
#define <a class="link" href="NMSettingWirelessSecurity.html#NM-TYPE-SETTING-WIRELESS-SECURITY-ERROR:CAPS" title="NM_TYPE_SETTING_WIRELESS_SECURITY_ERROR">NM_TYPE_SETTING_WIRELESS_SECURITY_ERROR</a>
#define <a class="link" href="NMSettingWirelessSecurity.html#NM-SETTING-WIRELESS-SECURITY-ERROR:CAPS" title="NM_SETTING_WIRELESS_SECURITY_ERROR">NM_SETTING_WIRELESS_SECURITY_ERROR</a>
@@ -159,6 +163,24 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<div class="refsect1" title="Description">
<a name="NMSettingWirelessSecurity.description"></a><h2>Description</h2>
<p>
+The <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes
+properties necessary for connection to encrypted WiFi networks.
+</p>
+<p>
+It's a good idea to read up on wpa_supplicant configuration before using this
+setting extensively, since most of the options here correspond closely with
+the relevant wpa_supplicant configuration options. To get a better overview
+of how WiFi security works, you may want to get copies of the following books.
+</p>
+<p>
+ 802.11 Wireless Networks: The Definitive Guide, Second Edition
+ Author: Matthew Gast
+ ISBN: 978-0596100520
+</p>
+<p>
+ Cisco Wireless LAN Security
+ Authors: Krishna Sankar, Sri Sundaralingam, Darrin Miller, and Andrew Balinsky
+ ISBN: 978-1587051548
</p>
</div>
<div class="refsect1" title="Details">
@@ -173,8 +195,7 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<hr>
<div class="refsect2" title="enum NMSettingWirelessSecurityError">
<a name="NMSettingWirelessSecurityError"></a><h3>enum NMSettingWirelessSecurityError</h3>
-<pre class="programlisting">typedef enum
-{
+<pre class="programlisting">typedef enum {
NM_SETTING_WIRELESS_SECURITY_ERROR_UNKNOWN = 0,
NM_SETTING_WIRELESS_SECURITY_ERROR_INVALID_PROPERTY,
NM_SETTING_WIRELESS_SECURITY_ERROR_MISSING_PROPERTY,
@@ -184,8 +205,52 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
NM_SETTING_WIRELESS_SECURITY_ERROR_SHARED_KEY_REQUIRES_WEP
} NMSettingWirelessSecurityError;
</pre>
-<p>
-</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><a name="NM-SETTING-WIRELESS-SECURITY-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_WIRELESS_SECURITY_ERROR_UNKNOWN</code></span></p></td>
+<td>unknown or unclassified error
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-WIRELESS-SECURITY-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_WIRELESS_SECURITY_ERROR_INVALID_PROPERTY</code></span></p></td>
+<td>the property was invalid
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-WIRELESS-SECURITY-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_WIRELESS_SECURITY_ERROR_MISSING_PROPERTY</code></span></p></td>
+<td>the property was
+missing and is required
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-WIRELESS-SECURITY-ERROR-MISSING-802-1X-SETTING:CAPS"></a><span class="term"><code class="literal">NM_SETTING_WIRELESS_SECURITY_ERROR_MISSING_802_1X_SETTING</code></span></p></td>
+<td>a property contained
+a value that requires the connection to contain a <a class="link" href="NMSetting8021x.html" title="NMSetting8021x"><span class="type">NMSetting8021x</span></a> setting
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-WIRELESS-SECURITY-ERROR-LEAP-REQUIRES-802-1X:CAPS"></a><span class="term"><code class="literal">NM_SETTING_WIRELESS_SECURITY_ERROR_LEAP_REQUIRES_802_1X</code></span></p></td>
+<td>LEAP authentication
+was specified but key management was not set to "8021x"
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-WIRELESS-SECURITY-ERROR-LEAP-REQUIRES-USERNAME:CAPS"></a><span class="term"><code class="literal">NM_SETTING_WIRELESS_SECURITY_ERROR_LEAP_REQUIRES_USERNAME</code></span></p></td>
+<td>LEAP authentication
+was specified but no LEAP username was given
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-SETTING-WIRELESS-SECURITY-ERROR-SHARED-KEY-REQUIRES-WEP:CAPS"></a><span class="term"><code class="literal">NM_SETTING_WIRELESS_SECURITY_ERROR_SHARED_KEY_REQUIRES_WEP</code></span></p></td>
+<td>Shared Key
+authentication was specified but the setting did not specify WEP as the
+encryption protocol
+</td>
+</tr>
+</tbody>
+</table></div>
</div>
<hr>
<div class="refsect2" title="NM_TYPE_SETTING_WIRELESS_SECURITY_ERROR">
@@ -231,7 +296,47 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
} NMWepKeyType;
</pre>
<p>
+The <a class="link" href="NMSettingWirelessSecurity.html#NMWepKeyType" title="enum NMWepKeyType"><span class="type">NMWepKeyType</span></a> values specify how any WEP keys present in the setting
+are intepreted. There are no standards governing how to hash the various WEP
+key/passphrase formats into the actual WEP key. Unfortunately some WEP keys
+can be interpreted in multiple ways, requring the setting to specify how to
+interpret the any WEP keys. For example, the key "732f2d712e4a394a375d366931"
+is both a valid Hexadecimal WEP key and a WEP passphrase. Further, many
+ASCII keys are also valid WEP passphrases, but since passphrases and ASCII
+keys are hashed differently to determine the actual WEP key the type must be
+specified.
</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><a name="NM-WEP-KEY-TYPE-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_WEP_KEY_TYPE_UNKNOWN</code></span></p></td>
+<td>unknown WEP key type
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-WEP-KEY-TYPE-KEY:CAPS"></a><span class="term"><code class="literal">NM_WEP_KEY_TYPE_KEY</code></span></p></td>
+<td>indicates a hexadecimal or ASCII formatted WEP key.
+Hex keys are either 10 or 26 hexadecimal characters (ie "5f782f2f5f" or
+"732f2d712e4a394a375d366931"), while ASCII keys are either 5 or 13 ASCII
+characters (ie "abcde" or "blahblah99$*1").
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-WEP-KEY-TYPE-PASSPHRASE:CAPS"></a><span class="term"><code class="literal">NM_WEP_KEY_TYPE_PASSPHRASE</code></span></p></td>
+<td>indicates a WEP passphrase (ex "I bought a duck
+on my way back from the market 235Q&^%^*%") instead of a hexadecimal or ASCII
+key. Passphrases are between 8 and 64 characters inclusive and are hashed
+the actual WEP key using the MD5 hash algorithm.
+</td>
+</tr>
+<tr>
+<td><p><a name="NM-WEP-KEY-TYPE-LAST:CAPS"></a><span class="term"><code class="literal">NM_WEP_KEY_TYPE_LAST</code></span></p></td>
+<td>placeholder value for bounds-checking
+</td>
+</tr>
+</tbody>
+</table></div>
</div>
<hr>
<div class="refsect2" title="NM_SETTING_WIRELESS_SECURITY_KEY_MGMT">
@@ -389,12 +494,13 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wireless-security-new"></a><h3>nm_setting_wireless_security_new ()</h3>
<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_wireless_security_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
+Creates a new <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> object with default values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the new empty <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> object
</td>
</tr></tbody>
</table></div>
@@ -404,19 +510,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wireless-security-get-key-mgmt"></a><h3>nm_setting_wireless_security_get_key_mgmt ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_wireless_security_get_key_mgmt
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--key-mgmt" title='The "key-mgmt" property'><span class="type">"key-mgmt"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -427,19 +531,18 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wireless-security-get-num-protos"></a><h3>nm_setting_wireless_security_get_num_protos ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_wireless_security_get_num_protos
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the number of security protocols this connection allows when
+connecting to secure WiFi networks
</td>
</tr>
</tbody>
@@ -451,24 +554,22 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_wireless_security_get_proto
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>an index into the protocol list
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the protocol at index <em class="parameter"><code>i</code></em>
</td>
</tr>
</tbody>
@@ -481,23 +582,30 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *proto</code></em>);</pre>
<p>
+Adds a WiFi security protocol (one of "wpa" or "rsn") to the allowed list;
+only protocols in this list will be used when finding and connecting to
+the WiFi network specified by this connection. For example, if the
+protocol list contains only "wpa" but the access point for the SSID specified
+by this connection only supports WPA2/RSN, the connection cannot be used
+with the access point.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>proto</code></em>Â:</span></p></td>
-<td>
+<td>the protocol to add, one of "wpa" or "rsn"
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the protocol was new and and was added to the allowed
+protocol list, or <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it was already in the list
</td>
</tr>
</tbody>
@@ -510,18 +618,19 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
<p>
+Removes a protocol from the allowed protocol list.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index of the protocol to remove
</td>
</tr>
</tbody>
@@ -533,12 +642,14 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_wireless_security_clear_protos
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>);</pre>
<p>
+Removes all protocols from the allowed list. If there are no protocols
+specified then all protocols are allowed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr></tbody>
</table></div>
@@ -548,19 +659,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wireless-security-get-num-pairwise"></a><h3>nm_setting_wireless_security_get_num_pairwise ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_wireless_security_get_num_pairwise
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the number of pairwise encryption algorithms in the allowed list
</td>
</tr>
</tbody>
@@ -573,23 +682,25 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
<p>
+Returns the allowed pairwise encryption algorithm from allowed algorithm
+list.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index of an item in the allowed pairwise encryption algorithm list
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the pairwise encryption algorithm at index <em class="parameter"><code>i</code></em>
</td>
</tr>
</tbody>
@@ -602,23 +713,29 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *pairwise</code></em>);</pre>
<p>
+Adds an encryption algorithm to the list of allowed pairwise encryption
+algorithms. If the list is not empty, then only access points that support
+one or more of the encryption algorithms in the list will be considered
+compatible with this connection.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pairwise</code></em>Â:</span></p></td>
-<td>
+<td>the encryption algorithm to add, one of "wep40", "wep104",
+"tkip", or "ccmp"
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the algorithm was added to the list, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it was
+already in the list
</td>
</tr>
</tbody>
@@ -631,18 +748,20 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
<p>
+Removes an encryption algorithm from the allowed pairwise encryption
+algorithm list.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>the index of an item in the allowed pairwise encryption algorithm list
</td>
</tr>
</tbody>
@@ -654,12 +773,14 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_wireless_security_clear_pairwise
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>);</pre>
<p>
+Removes all algorithms from the allowed list. If there are no algorithms
+specified then all pairwise encryption algorithms are allowed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr></tbody>
</table></div>
@@ -669,19 +790,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wireless-security-get-num-groups"></a><h3>nm_setting_wireless_security_get_num_groups ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_wireless_security_get_num_groups
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the number of groupwise encryption algorithms in the allowed list
</td>
</tr>
</tbody>
@@ -694,23 +813,25 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
<p>
+Returns the allowed groupwise encryption algorithm from allowed algorithm
+list.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>index of an item in the allowed groupwise encryption algorithm list
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the groupwise encryption algorithm at index <em class="parameter"><code>i</code></em>
</td>
</tr>
</tbody>
@@ -723,23 +844,29 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *group</code></em>);</pre>
<p>
+Adds an encryption algorithm to the list of allowed groupwise encryption
+algorithms. If the list is not empty, then only access points that support
+one or more of the encryption algorithms in the list will be considered
+compatible with this connection.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em>Â:</span></p></td>
-<td>
+<td>the encryption algorithm to add, one of "wep40", "wep104",
+"tkip", or "ccmp"
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the algorithm was added to the list, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it was
+already in the list
</td>
</tr>
</tbody>
@@ -752,18 +879,20 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> i</code></em>);</pre>
<p>
+Removes an encryption algorithm from the allowed groupwise encryption
+algorithm list.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em>Â:</span></p></td>
-<td>
+<td>the index of an item in the allowed groupwise encryption algorithm list
</td>
</tr>
</tbody>
@@ -775,12 +904,14 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_wireless_security_clear_groups
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>);</pre>
<p>
+Removes all algorithms from the allowed list. If there are no algorithms
+specified then all groupwise encryption algorithms are allowed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr></tbody>
</table></div>
@@ -790,19 +921,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wireless-security-get-psk"></a><h3>nm_setting_wireless_security_get_psk ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_wireless_security_get_psk
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--psk" title='The "psk" property'><span class="type">"psk"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -813,19 +942,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wireless-security-get-leap-username"></a><h3>nm_setting_wireless_security_get_leap_username ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_wireless_security_get_leap_username
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--leap-username" title='The "leap-username" property'><span class="type">"leap-username"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -836,19 +963,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wireless-security-get-leap-password"></a><h3>nm_setting_wireless_security_get_leap_password ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_wireless_security_get_leap_password
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--leap-password" title='The "leap-password" property'><span class="type">"leap-password"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -860,24 +985,22 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_wireless_security_get_wep_key
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> idx</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>idx</code></em>Â:</span></p></td>
-<td>
+<td>the WEP key index (0..3 inclusive)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the WEP key at the given index
</td>
</tr>
</tbody>
@@ -891,23 +1014,26 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> idx</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>);</pre>
<p>
+Sets a WEP key in the given index.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>idx</code></em>Â:</span></p></td>
-<td>
+<td>the index of the key (0..3 inclusive)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em>Â:</span></p></td>
-<td>
+<td>the WEP key as a string, in either hexadecimal, ASCII, or passphrase
+form as determiend by the value of the <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--wep-key-type" title='The "wep-key-type" property'><span class="type">"wep-key-type"</span></a>
+property.
</td>
</tr>
</tbody>
@@ -918,19 +1044,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wireless-security-get-wep-tx-keyidx"></a><h3>nm_setting_wireless_security_get_wep_tx_keyidx ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_wireless_security_get_wep_tx_keyidx
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--wep-tx-keyidx" title='The "wep-tx-keyidx" property'><span class="type">"wep-tx-keyidx"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -941,19 +1065,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wireless-security-get-auth-alg"></a><h3>nm_setting_wireless_security_get_auth_alg ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_wireless_security_get_auth_alg
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--auth-alg" title='The "auth-alg" property'><span class="type">"auth-alg"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -964,19 +1086,17 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet
<a name="nm-setting-wireless-security-get-wep-key-type"></a><h3>nm_setting_wireless_security_get_wep_key_type ()</h3>
<pre class="programlisting"><a class="link" href="NMSettingWirelessSecurity.html#NMWepKeyType" title="enum NMWepKeyType"><span class="returnvalue">NMWepKeyType</span></a> nm_setting_wireless_security_get_wep_key_type
(<em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> *setting</code></em>);</pre>
-<p>
-</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em>Â:</span></p></td>
-<td>
+<td>the <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> the <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--wep-key-type" title='The "wep-key-type" property'><span class="type">"wep-key-type"</span></a> property of the setting
</td>
</tr>
</tbody>
@@ -1078,9 +1198,8 @@ connecting to the WiFi network.
<a name="NMSettingWirelessSecurity--wep-key-type"></a><h3>The <code class="literal">"wep-key-type"</code> property</h3>
<pre class="programlisting"> "wep-key-type" <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct</pre>
<p>
-Controls the interpretation of WEP keys. Allowed values are 1 (interpret
-WEP keys as hexadecimal or ASCII keys) or 2 (interpret WEP keys as WEP
-Passphrases). If set to 1 and the keys are hexadecimal, they must be
+Controls the interpretation of WEP keys. Allowed values are those given
+by <a class="link" href="NMSettingWirelessSecurity.html#NMWepKeyType" title="enum NMWepKeyType"><code class="literal">NMWepKeyType</code></a>. If set to 1 and the keys are hexadecimal, they must be
either 10 or 26 characters in length. If set to 1 and the keys are
ASCII keys, they must be either 5 or 13 characters in length. If set to
2, the passphrase is hashed using the de-facto MD5 method to derive the
diff --git a/projects.gnome.org/NetworkManager/developers/libnm-util/08/api-index-full.html b/projects.gnome.org/NetworkManager/developers/libnm-util/08/api-index-full.html
index 195b24d..55e34c0 100644
--- a/projects.gnome.org/NetworkManager/developers/libnm-util/08/api-index-full.html
+++ b/projects.gnome.org/NetworkManager/developers/libnm-util/08/api-index-full.html
@@ -7,7 +7,6 @@
<link rel="home" href="index.html" title="libnm-util Reference Manual">
<link rel="up" href="index.html" title="libnm-util Reference Manual">
<link rel="prev" href="object-tree.html" title="Object Hierarchy">
-<link rel="next" href="annotation-glossary.html" title="Annotation Glossary">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
@@ -18,7 +17,7 @@
<td>Â</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libnm-util Reference Manual</th>
-<td><a accesskey="n" href="annotation-glossary.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
+<td>Â</td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a class="shortcut" href="#idxC">C</a>
@@ -1055,6 +1054,10 @@
</dt>
<dd></dd>
<dt>
+<a class="link" href="NMSettingWired.html#NMSettingWired--mac-address-blacklist" title='The "mac-address-blacklist" property'>NMSettingWired:mac-address-blacklist</a>, object property in <a class="link" href="NMSettingWired.html" title="NMSettingWired">NMSettingWired</a>
+</dt>
+<dd></dd>
+<dt>
<a class="link" href="NMSettingWired.html#NMSettingWired--mtu" title='The "mtu" property'>NMSettingWired:mtu</a>, object property in <a class="link" href="NMSettingWired.html" title="NMSettingWired">NMSettingWired</a>
</dt>
<dd></dd>
@@ -1111,6 +1114,10 @@
</dt>
<dd></dd>
<dt>
+<a class="link" href="NMSettingWireless.html#NMSettingWireless--mac-address-blacklist" title='The "mac-address-blacklist" property'>NMSettingWireless:mac-address-blacklist</a>, object property in <a class="link" href="NMSettingWireless.html" title="NMSettingWireless">NMSettingWireless</a>
+</dt>
+<dd></dd>
+<dt>
<a class="link" href="NMSettingWireless.html#NMSettingWireless--mode" title='The "mode" property'>NMSettingWireless:mode</a>, object property in <a class="link" href="NMSettingWireless.html" title="NMSettingWireless">NMSettingWireless</a>
</dt>
<dd></dd>
@@ -2715,6 +2722,10 @@
</dt>
<dd></dd>
<dt>
+<a class="link" href="NMSettingWired.html#nm-setting-wired-get-mac-address-blacklist" title="nm_setting_wired_get_mac_address_blacklist ()">nm_setting_wired_get_mac_address_blacklist</a>, function in <a class="link" href="NMSettingWired.html" title="NMSettingWired">NMSettingWired</a>
+</dt>
+<dd></dd>
+<dt>
<a class="link" href="NMSettingWired.html#nm-setting-wired-get-mtu" title="nm_setting_wired_get_mtu ()">nm_setting_wired_get_mtu</a>, function in <a class="link" href="NMSettingWired.html" title="NMSettingWired">NMSettingWired</a>
</dt>
<dd></dd>
@@ -2755,6 +2766,10 @@
</dt>
<dd></dd>
<dt>
+<a class="link" href="NMSettingWired.html#NM-SETTING-WIRED-MAC-ADDRESS-BLACKLIST:CAPS" title="NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST">NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST</a>, macro in <a class="link" href="NMSettingWired.html" title="NMSettingWired">NMSettingWired</a>
+</dt>
+<dd></dd>
+<dt>
<a class="link" href="NMSettingWired.html#NM-SETTING-WIRED-MTU:CAPS" title="NM_SETTING_WIRED_MTU">NM_SETTING_WIRED_MTU</a>, macro in <a class="link" href="NMSettingWired.html" title="NMSettingWired">NMSettingWired</a>
</dt>
<dd></dd>
@@ -2843,6 +2858,10 @@
</dt>
<dd></dd>
<dt>
+<a class="link" href="NMSettingWireless.html#nm-setting-wireless-get-mac-address-blacklist" title="nm_setting_wireless_get_mac_address_blacklist ()">nm_setting_wireless_get_mac_address_blacklist</a>, function in <a class="link" href="NMSettingWireless.html" title="NMSettingWireless">NMSettingWireless</a>
+</dt>
+<dd></dd>
+<dt>
<a class="link" href="NMSettingWireless.html#nm-setting-wireless-get-mode" title="nm_setting_wireless_get_mode ()">nm_setting_wireless_get_mode</a>, function in <a class="link" href="NMSettingWireless.html" title="NMSettingWireless">NMSettingWireless</a>
</dt>
<dd></dd>
@@ -2883,10 +2902,22 @@
</dt>
<dd></dd>
<dt>
+<a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-MAC-ADDRESS-BLACKLIST:CAPS" title="NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST">NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST</a>, macro in <a class="link" href="NMSettingWireless.html" title="NMSettingWireless">NMSettingWireless</a>
+</dt>
+<dd></dd>
+<dt>
<a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-MODE:CAPS" title="NM_SETTING_WIRELESS_MODE">NM_SETTING_WIRELESS_MODE</a>, macro in <a class="link" href="NMSettingWireless.html" title="NMSettingWireless">NMSettingWireless</a>
</dt>
<dd></dd>
<dt>
+<a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-MODE-ADHOC:CAPS" title="NM_SETTING_WIRELESS_MODE_ADHOC">NM_SETTING_WIRELESS_MODE_ADHOC</a>, macro in <a class="link" href="NMSettingWireless.html" title="NMSettingWireless">NMSettingWireless</a>
+</dt>
+<dd></dd>
+<dt>
+<a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-MODE-INFRA:CAPS" title="NM_SETTING_WIRELESS_MODE_INFRA">NM_SETTING_WIRELESS_MODE_INFRA</a>, macro in <a class="link" href="NMSettingWireless.html" title="NMSettingWireless">NMSettingWireless</a>
+</dt>
+<dd></dd>
+<dt>
<a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-MTU:CAPS" title="NM_SETTING_WIRELESS_MTU">NM_SETTING_WIRELESS_MTU</a>, macro in <a class="link" href="NMSettingWireless.html" title="NMSettingWireless">NMSettingWireless</a>
</dt>
<dd></dd>
diff --git a/projects.gnome.org/NetworkManager/developers/libnm-util/08/ch01.html b/projects.gnome.org/NetworkManager/developers/libnm-util/08/ch01.html
index 545175e..2e9734e 100644
--- a/projects.gnome.org/NetworkManager/developers/libnm-util/08/ch01.html
+++ b/projects.gnome.org/NetworkManager/developers/libnm-util/08/ch01.html
@@ -21,7 +21,7 @@
</tr></table>
<div class="chapter" title="libnm-util API Reference">
<div class="titlepage"><div><div><h2 class="title">
-<a name="id2699944"></a>libnm-util API Reference</h2></div></div></div>
+<a name="id2871558"></a>libnm-util API Reference</h2></div></div></div>
<div class="toc"><dl>
<dt>
<span class="refentrytitle"><a href="NMConnection.html">NMConnection</a></span><span class="refpurpose"> â Describes a connection to specific network or provider</span>
@@ -33,25 +33,27 @@
<span class="refentrytitle"><a href="NMSettingConnection.html">NMSettingConnection</a></span><span class="refpurpose"> â Describes general connection properties</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingWired.html">NMSettingWired</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingWired.html">NMSettingWired</a></span><span class="refpurpose"> â Describes connection properties for Ethernet-based networks</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingWireless.html">NMSettingWireless</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingWireless.html">NMSettingWireless</a></span><span class="refpurpose"> â Describes connection properties for 802.11 WiFi networks</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingWirelessSecurity.html">NMSettingWirelessSecurity</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingWirelessSecurity.html">NMSettingWirelessSecurity</a></span><span class="refpurpose"> â Describes connection properties for WiFi networks that
+use WEP, LEAP, WPA or WPA2/RSN security</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingBluetooth.html">NMSettingBluetooth</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingBluetooth.html">NMSettingBluetooth</a></span><span class="refpurpose"> â Describes Bluetooth connection properties</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingSerial.html">NMSettingSerial</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingSerial.html">NMSettingSerial</a></span><span class="refpurpose"> â Describes connection properties for devices that use
+serial communications</span>
</dt>
<dt>
<span class="refentrytitle"><a href="NMSettingCdma.html">NMSettingCdma</a></span><span class="refpurpose"> â Describes CDMA-based mobile broadband properties</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingGsm.html">NMSettingGsm</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingGsm.html">NMSettingGsm</a></span><span class="refpurpose"> â Describes GSM/3GPP-based mobile broadband properties</span>
</dt>
<dt>
<span class="refentrytitle"><a href="NMSettingOlpcMesh.html">NMSettingOlpcMesh</a></span><span class="refpurpose"></span>
@@ -60,19 +62,20 @@
<span class="refentrytitle"><a href="NMSetting8021x.html">NMSetting8021x</a></span><span class="refpurpose"> â Describes 802.1x-authenticated connection properties</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingIP4Config.html">NMSettingIP4Config</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingIP4Config.html">NMSettingIP4Config</a></span><span class="refpurpose"> â Describes IPv4 addressing, routing, and name service properties</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingIP6Config.html">NMSettingIP6Config</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingIP6Config.html">NMSettingIP6Config</a></span><span class="refpurpose"> â Describes IPv6 addressing, routing, and name service properties</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingPPP.html">NMSettingPPP</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingPPP.html">NMSettingPPP</a></span><span class="refpurpose"> â Describes connection properties for devices/networks
+that require PPP to deliver IP capability</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingPPPOE.html">NMSettingPPPOE</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingPPPOE.html">NMSettingPPPOE</a></span><span class="refpurpose"> â Describes PPPoE connection properties</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingVPN.html">NMSettingVPN</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingVPN.html">NMSettingVPN</a></span><span class="refpurpose"> â Describes connection properties for Virtual Private Networks</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libnm-util-nm-utils.html">nm-utils</a></span><span class="refpurpose"> â Utility functions</span>
diff --git a/projects.gnome.org/NetworkManager/developers/libnm-util/08/index.html b/projects.gnome.org/NetworkManager/developers/libnm-util/08/index.html
index 69dc282..f61e776 100644
--- a/projects.gnome.org/NetworkManager/developers/libnm-util/08/index.html
+++ b/projects.gnome.org/NetworkManager/developers/libnm-util/08/index.html
@@ -35,25 +35,27 @@
<span class="refentrytitle"><a href="NMSettingConnection.html">NMSettingConnection</a></span><span class="refpurpose"> â Describes general connection properties</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingWired.html">NMSettingWired</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingWired.html">NMSettingWired</a></span><span class="refpurpose"> â Describes connection properties for Ethernet-based networks</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingWireless.html">NMSettingWireless</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingWireless.html">NMSettingWireless</a></span><span class="refpurpose"> â Describes connection properties for 802.11 WiFi networks</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingWirelessSecurity.html">NMSettingWirelessSecurity</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingWirelessSecurity.html">NMSettingWirelessSecurity</a></span><span class="refpurpose"> â Describes connection properties for WiFi networks that
+use WEP, LEAP, WPA or WPA2/RSN security</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingBluetooth.html">NMSettingBluetooth</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingBluetooth.html">NMSettingBluetooth</a></span><span class="refpurpose"> â Describes Bluetooth connection properties</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingSerial.html">NMSettingSerial</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingSerial.html">NMSettingSerial</a></span><span class="refpurpose"> â Describes connection properties for devices that use
+serial communications</span>
</dt>
<dt>
<span class="refentrytitle"><a href="NMSettingCdma.html">NMSettingCdma</a></span><span class="refpurpose"> â Describes CDMA-based mobile broadband properties</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingGsm.html">NMSettingGsm</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingGsm.html">NMSettingGsm</a></span><span class="refpurpose"> â Describes GSM/3GPP-based mobile broadband properties</span>
</dt>
<dt>
<span class="refentrytitle"><a href="NMSettingOlpcMesh.html">NMSettingOlpcMesh</a></span><span class="refpurpose"></span>
@@ -62,19 +64,20 @@
<span class="refentrytitle"><a href="NMSetting8021x.html">NMSetting8021x</a></span><span class="refpurpose"> â Describes 802.1x-authenticated connection properties</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingIP4Config.html">NMSettingIP4Config</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingIP4Config.html">NMSettingIP4Config</a></span><span class="refpurpose"> â Describes IPv4 addressing, routing, and name service properties</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingIP6Config.html">NMSettingIP6Config</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingIP6Config.html">NMSettingIP6Config</a></span><span class="refpurpose"> â Describes IPv6 addressing, routing, and name service properties</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingPPP.html">NMSettingPPP</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingPPP.html">NMSettingPPP</a></span><span class="refpurpose"> â Describes connection properties for devices/networks
+that require PPP to deliver IP capability</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingPPPOE.html">NMSettingPPPOE</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingPPPOE.html">NMSettingPPPOE</a></span><span class="refpurpose"> â Describes PPPoE connection properties</span>
</dt>
<dt>
-<span class="refentrytitle"><a href="NMSettingVPN.html">NMSettingVPN</a></span><span class="refpurpose"></span>
+<span class="refentrytitle"><a href="NMSettingVPN.html">NMSettingVPN</a></span><span class="refpurpose"> â Describes connection properties for Virtual Private Networks</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libnm-util-nm-utils.html">nm-utils</a></span><span class="refpurpose"> â Utility functions</span>
@@ -82,7 +85,6 @@
</dl></dd>
<dt><span class="chapter"><a href="object-tree.html">Object Hierarchy</a></span></dt>
<dt><span class="index"><a href="api-index-full.html">API Index</a></span></dt>
-<dt><span class="glossary"><a href="annotation-glossary.html">Annotation Glossary</a></span></dt>
</dl></div>
</div>
<div class="footer">
diff --git a/projects.gnome.org/NetworkManager/developers/libnm-util/08/libnm-util-nm-utils.html b/projects.gnome.org/NetworkManager/developers/libnm-util/08/libnm-util-nm-utils.html
index d97bd06..115ebee 100644
--- a/projects.gnome.org/NetworkManager/developers/libnm-util/08/libnm-util-nm-utils.html
+++ b/projects.gnome.org/NetworkManager/developers/libnm-util/08/libnm-util-nm-utils.html
@@ -950,18 +950,20 @@ which should be unset by the caller (when no longer needed) with
<a name="nm-utils-ip6-dns-from-gvalue"></a><h3>nm_utils_ip6_dns_from_gvalue ()</h3>
<pre class="programlisting"><a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * nm_utils_ip6_dns_from_gvalue (<em class="parameter"><code>const <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
<p>
+Converts a <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> containing a <a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> of IP6 DNS, represented as
+<a href="../glib/glib-Byte-Arrays.html#GByteArray"><span class="type">GByteArray</span></a>s into a <a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <span class="type">in6_addr</span>s.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em>Â:</span></p></td>
-<td>
+<td>a <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>Â:</span></p></td>
-<td>
+<td> a <a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of IP6 addresses.
</td>
</tr>
</tbody>
@@ -973,18 +975,24 @@ which should be unset by the caller (when no longer needed) with
<pre class="programlisting"><span class="returnvalue">void</span> nm_utils_ip6_dns_to_gvalue (<em class="parameter"><code><a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *list</code></em>,
<em class="parameter"><code><a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
<p>
+Utility function to convert a <a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of 'struct in6_addr' structs into a
+GPtrArray of GByteArrays representing each server's IPv6 addresses in
+network byte order. The specific format of this serialization is not
+guaranteed to be stable and may be extended in the future.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em>Â:</span></p></td>
-<td>
+<td>a list of <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> objects
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em>Â:</span></p></td>
-<td>
+<td>a pointer to a <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> into which to place the converted DNS server
+addresses, which should be unset by the caller (when no longer needed) with
+<a href="../gobject/gobject-Generic-values.html#g-value-unset"><code class="function">g_value_unset()</code></a>.
</td>
</tr>
</tbody>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
