diff options
| author | Michael Biebl <biebl@debian.org> | 2011-08-23 19:16:47 +0200 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2011-08-23 19:16:47 +0200 |
| commit | 263bf4c0c89bb88dc995acd9a6a2de9095fbd461 (patch) | |
| tree | 7224326afe367409e7150e49fad9029f81fe24b8 /docs/libnm-util/html/NMSettingIP4Config.html | |
| parent | d465e5fac63f36bcf4069e36827f4b62c494556d (diff) | |
Imported Upstream version 0.9.0 upstream/0.9.0
Diffstat (limited to 'docs/libnm-util/html/NMSettingIP4Config.html')
| -rw-r--r-- | docs/libnm-util/html/NMSettingIP4Config.html | 885 |
1 files changed, 859 insertions, 26 deletions
diff --git a/docs/libnm-util/html/NMSettingIP4Config.html b/docs/libnm-util/html/NMSettingIP4Config.html index 6a701adf..488f842a 100644 --- a/docs/libnm-util/html/NMSettingIP4Config.html +++ b/docs/libnm-util/html/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"> <a name="NMSettingIP4Config.synopsis"></a><h2>Synopsis</h2> -<a name="NMSettingIP4ConfigError"></a><a name="NMIP4Address"></a><a name="NMIP4Route"></a><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> +<a name="NMSettingIP4ConfigError"></a><a name="NMIP4Address"></a><a name="NMIP4Route"></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">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> @@ -83,7 +86,7 @@ typedef <a class="link" href="NMSettingIP4Config.html#NMIP4Address"> typedef <a class="link" href="NMSettingIP4Config.html#NMIP4Route">NMIP4Route</a>; <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="NMSettingIP4Config.html#nm-ip4-route-get-type" title="nm_ip4_route_get_type ()">nm_ip4_route_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>); <a class="link" href="NMSettingIP4Config.html#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"><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"><span class="type">NMIP4Route</span></a> *route</code></em>); +<a class="link" href="NMSettingIP4Config.html#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"><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"><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"><span class="type">NMIP4Route</span></a> *route</code></em>); <a href="http://library.gnome.org/devel/glib/unstable/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"><span class="type">NMIP4Route</span></a> *route</code></em>, @@ -201,6 +204,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <div class="refsect1"> <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"> @@ -215,16 +220,40 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <hr> <div class="refsect2"> <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"> @@ -247,7 +276,15 @@ 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="http://library.gnome.org/devel/glib/unstable/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>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> </div> <hr> <div class="refsect2"> @@ -351,6 +388,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> @@ -359,6 +399,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> @@ -367,6 +409,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> @@ -375,6 +419,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> @@ -383,6 +433,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> @@ -405,28 +456,71 @@ 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"><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"><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>the new empty <a class="link" href="NMSettingIP4Config.html#NMIP4Address"><span class="type">NMIP4Address</span></a> object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr></tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-ip4-address-dup"></a><h3>nm_ip4_address_dup ()</h3> <pre class="programlisting"><a class="link" href="NMSettingIP4Config.html#NMIP4Address"><span class="returnvalue">NMIP4Address</span></a> * nm_ip4_address_dup (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Address"><span class="type">NMIP4Address</span></a> *source</code></em>);</pre> <p> +Copies a given <a class="link" href="NMSettingIP4Config.html#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>the <a class="link" href="NMSettingIP4Config.html#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>the copy of the given <a class="link" href="NMSettingIP4Config.html#NMIP4Address"><span class="type">NMIP4Address</span></a> copy. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <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"><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>the <a class="link" href="NMSettingIP4Config.html#NMIP4Address"><span class="type">NMIP4Address</span></a> +</td> +</tr></tbody> +</table></div> </div> <hr> <div class="refsect2"> <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"><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>the <a class="link" href="NMSettingIP4Config.html#NMIP4Address"><span class="type">NMIP4Address</span></a> +</td> +</tr></tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -434,14 +528,49 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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"><span class="type">NMIP4Address</span></a> *address</code></em>, <em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Address"><span class="type">NMIP4Address</span></a> *other</code></em>);</pre> <p> +Determines if two <a class="link" href="NMSettingIP4Config.html#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>the <a class="link" href="NMSettingIP4Config.html#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>the <a class="link" href="NMSettingIP4Config.html#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> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the objects contain the same values, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if they do not.</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-ip4-address-get-address"></a><h3>nm_ip4_address_get_address ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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"><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>the <a class="link" href="NMSettingIP4Config.html#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>the IPv4 address in network byte order</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -449,14 +578,45 @@ 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"><span class="type">NMIP4Address</span></a> *address</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/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>the <a class="link" href="NMSettingIP4Config.html#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>the IPv4 address in network byte order</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-ip4-address-get-prefix"></a><h3>nm_ip4_address_get_prefix ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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"><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>the <a class="link" href="NMSettingIP4Config.html#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>the IPv4 address prefix</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -464,14 +624,44 @@ 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"><span class="type">NMIP4Address</span></a> *address</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/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>the <a class="link" href="NMSettingIP4Config.html#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>the address prefix, a number between 1 and 32 inclusive</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-ip4-address-get-gateway"></a><h3>nm_ip4_address_get_gateway ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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"><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>the <a class="link" href="NMSettingIP4Config.html#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>the IPv4 gateway address in network byte order</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -479,7 +669,22 @@ 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"><span class="type">NMIP4Address</span></a> *address</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/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>the <a class="link" href="NMSettingIP4Config.html#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>the IPv4 default gateway in network byte order</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -501,28 +706,71 @@ 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"><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"><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>the new empty <a class="link" href="NMSettingIP4Config.html#NMIP4Route"><span class="type">NMIP4Route</span></a> object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr></tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-ip4-route-dup"></a><h3>nm_ip4_route_dup ()</h3> -<pre class="programlisting"><a class="link" href="NMSettingIP4Config.html#NMIP4Route"><span class="returnvalue">NMIP4Route</span></a> * nm_ip4_route_dup (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route"><span class="type">NMIP4Route</span></a> *route</code></em>);</pre> +<pre class="programlisting"><a class="link" href="NMSettingIP4Config.html#NMIP4Route"><span class="returnvalue">NMIP4Route</span></a> * nm_ip4_route_dup (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route"><span class="type">NMIP4Route</span></a> *source</code></em>);</pre> <p> +Copies a given <a class="link" href="NMSettingIP4Config.html#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>source</code></em> :</span></p></td> +<td>the <a class="link" href="NMSettingIP4Config.html#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>the copy of the given <a class="link" href="NMSettingIP4Config.html#NMIP4Route"><span class="type">NMIP4Route</span></a> copy. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <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"><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>the <a class="link" href="NMSettingIP4Config.html#NMIP4Route"><span class="type">NMIP4Route</span></a> +</td> +</tr></tbody> +</table></div> </div> <hr> <div class="refsect2"> <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"><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>the <a class="link" href="NMSettingIP4Config.html#NMIP4Route"><span class="type">NMIP4Route</span></a> +</td> +</tr></tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -530,14 +778,49 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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"><span class="type">NMIP4Route</span></a> *route</code></em>, <em class="parameter"><code><a class="link" href="NMSettingIP4Config.html#NMIP4Route"><span class="type">NMIP4Route</span></a> *other</code></em>);</pre> <p> +Determines if two <a class="link" href="NMSettingIP4Config.html#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>the <a class="link" href="NMSettingIP4Config.html#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>the <a class="link" href="NMSettingIP4Config.html#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> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the objects contain the same values, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if they do not.</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-ip4-route-get-dest"></a><h3>nm_ip4_route_get_dest ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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"><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>the <a class="link" href="NMSettingIP4Config.html#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>the IPv4 address in network byte order</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -545,14 +828,44 @@ 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"><span class="type">NMIP4Route</span></a> *route</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/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>the <a class="link" href="NMSettingIP4Config.html#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>the destination address in network byte order</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-ip4-route-get-prefix"></a><h3>nm_ip4_route_get_prefix ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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"><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>the <a class="link" href="NMSettingIP4Config.html#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>the IPv4 prefix</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -560,14 +873,44 @@ 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"><span class="type">NMIP4Route</span></a> *route</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/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>the <a class="link" href="NMSettingIP4Config.html#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>the prefix, a number between 1 and 32 inclusive</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-ip4-route-get-next-hop"></a><h3>nm_ip4_route_get_next_hop ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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"><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>the <a class="link" href="NMSettingIP4Config.html#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>the IPv4 address in network byte order</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -575,14 +918,45 @@ 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"><span class="type">NMIP4Route</span></a> *route</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/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>the <a class="link" href="NMSettingIP4Config.html#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>the IPv4 address of the next hop in network byte order</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-ip4-route-get-metric"></a><h3>nm_ip4_route_get_metric ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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"><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>the <a class="link" href="NMSettingIP4Config.html#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>the route metric</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -590,7 +964,23 @@ 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"><span class="type">NMIP4Route</span></a> *route</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/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>the <a class="link" href="NMSettingIP4Config.html#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>the route metric</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -627,29 +1017,80 @@ 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>the new empty <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr></tbody> +</table></div> </div> <hr> <div class="refsect2"> <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>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>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> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-setting-ip4-config-get-num-dns"></a><h3>nm_setting_ip4_config_get_num_dns ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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>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>the number of configured DNS servers</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-setting-ip4-config-get-dns"></a><h3>nm_setting_ip4_config_get_dns ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/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>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>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>the IPv4 address (network byte order) of the DNS server at index +<em class="parameter"><code>i</code></em> +</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -657,7 +1098,28 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/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>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>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> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the DNS server was added; <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the server was already +known</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -665,22 +1127,58 @@ 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="http://library.gnome.org/devel/glib/unstable/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>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>index number of the DNS server to remove</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <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>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> +</td> +</tr></tbody> +</table></div> </div> <hr> <div class="refsect2"> <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="http://library.gnome.org/devel/glib/unstable/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>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>the number of configured DNS search domains</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -688,8 +1186,25 @@ 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="http://library.gnome.org/devel/glib/unstable/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>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>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>the DNS search domain at index <em class="parameter"><code>i</code></em> +</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -698,7 +1213,28 @@ 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>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>the search domain to add</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the DNS search domain was added; <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the search +domain was already known</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -707,7 +1243,22 @@ 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="http://library.gnome.org/devel/glib/unstable/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>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>index number of the DNS search domain</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -715,23 +1266,61 @@ 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>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> +</td> +</tr></tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-setting-ip4-config-get-num-addresses"></a><h3>nm_setting_ip4_config_get_num_addresses ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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>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>the number of configured addresses</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <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"><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="http://library.gnome.org/devel/glib/unstable/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>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>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>the address at index <em class="parameter"><code>i</code></em> +</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -739,7 +1328,29 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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"><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>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>the new address to add</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the address was added; <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the address was already +known.</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -748,7 +1359,22 @@ 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="http://library.gnome.org/devel/glib/unstable/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>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>index number of the address to remove</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -756,23 +1382,61 @@ 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>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> +</td> +</tr></tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-setting-ip4-config-get-num-routes"></a><h3>nm_setting_ip4_config_get_num_routes ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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>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>the number of configured routes</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <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"><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="http://library.gnome.org/devel/glib/unstable/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>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>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>the route at index <em class="parameter"><code>i</code></em> +</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -780,7 +1444,28 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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"><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>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>the route to add</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the route was added; <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the route was already known.</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -788,14 +1473,38 @@ 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="http://library.gnome.org/devel/glib/unstable/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>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>index number of the route</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <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>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> +</td> +</tr></tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -803,7 +1512,25 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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>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> +<a href="http://library.gnome.org/devel/glib/unstable/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> +</table></div> </div> <hr> <div class="refsect2"> @@ -811,7 +1538,25 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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>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> +<a href="http://library.gnome.org/devel/glib/unstable/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> +</table></div> </div> <hr> <div class="refsect2"> @@ -819,7 +1564,24 @@ 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>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>the configured Client ID to send to the DHCP server when requesting +addresses via DHCP.</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -827,7 +1589,26 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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>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> +<a href="http://library.gnome.org/devel/glib/unstable/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> +</table></div> </div> <hr> <div class="refsect2"> @@ -835,7 +1616,23 @@ 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>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>the configured hostname to send to the DHCP server</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -843,14 +1640,50 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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>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> +<a href="http://library.gnome.org/devel/glib/unstable/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> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-setting-ip4-config-get-may-fail"></a><h3>nm_setting_ip4_config_get_may_fail ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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>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> +<a href="http://library.gnome.org/devel/glib/unstable/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> +</table></div> </div> </div> <div class="refsect1"> |