diff options
Diffstat (limited to 'docs/libnm-glib/html/NMIP4Config.html')
| -rw-r--r-- | docs/libnm-glib/html/NMIP4Config.html | 585 |
1 files changed, 324 insertions, 261 deletions
diff --git a/docs/libnm-glib/html/NMIP4Config.html b/docs/libnm-glib/html/NMIP4Config.html index 7aa6f67d..4c5fbe76 100644 --- a/docs/libnm-glib/html/NMIP4Config.html +++ b/docs/libnm-glib/html/NMIP4Config.html @@ -2,36 +2,28 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NMIP4Config</title> +<title>libnm-glib Reference Manual: NMIP4Config</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="libnm-glib Reference Manual"> <link rel="up" href="ch02.html" title="libnm-glib API Reference"> <link rel="prev" href="NMAccessPoint.html" title="NMAccessPoint"> <link rel="next" href="NMIP6Config.html" title="NMIP6Config"> -<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> -<tr valign="middle"> -<td><a accesskey="p" href="NMAccessPoint.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></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-glib Reference Manual</th> -<td><a accesskey="n" href="NMIP6Config.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#NMIP4Config.synopsis" class="shortcut">Top</a> - | - <a href="#NMIP4Config.description" class="shortcut">Description</a> - | - <a href="#NMIP4Config.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#NMIP4Config.implemented-interfaces" class="shortcut">Implemented Interfaces</a> - | - <a href="#NMIP4Config.properties" class="shortcut">Properties</a> -</td></tr> -</table> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#NMIP4Config.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#NMIP4Config.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#NMIP4Config.properties" class="shortcut">Properties</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="NMAccessPoint.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="NMIP6Config.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="NMIP4Config"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -39,334 +31,405 @@ <h2><span class="refentrytitle"><a name="NMIP4Config.top_of_page"></a>NMIP4Config</span></h2> <p>NMIP4Config</p> </td> -<td valign="top" align="right"></td> +<td class="gallery_image" valign="top" align="right"></td> </tr></table></div> -<div class="refsynopsisdiv"> -<a name="NMIP4Config.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> <a class="link" href="NMIP4Config.html#NMIP4Config-struct" title="NMIP4Config">NMIP4Config</a>; - <a class="link" href="NMIP4Config.html#NMIP4ConfigClass" title="NMIP4ConfigClass">NMIP4ConfigClass</a>; -#define <a class="link" href="NMIP4Config.html#NM-IP4-CONFIG-ADDRESSES:CAPS" title="NM_IP4_CONFIG_ADDRESSES">NM_IP4_CONFIG_ADDRESSES</a> -#define <a class="link" href="NMIP4Config.html#NM-IP4-CONFIG-NAMESERVERS:CAPS" title="NM_IP4_CONFIG_NAMESERVERS">NM_IP4_CONFIG_NAMESERVERS</a> -#define <a class="link" href="NMIP4Config.html#NM-IP4-CONFIG-DOMAINS:CAPS" title="NM_IP4_CONFIG_DOMAINS">NM_IP4_CONFIG_DOMAINS</a> -#define <a class="link" href="NMIP4Config.html#NM-IP4-CONFIG-ROUTES:CAPS" title="NM_IP4_CONFIG_ROUTES">NM_IP4_CONFIG_ROUTES</a> -#define <a class="link" href="NMIP4Config.html#NM-IP4-CONFIG-WINS-SERVERS:CAPS" title="NM_IP4_CONFIG_WINS_SERVERS">NM_IP4_CONFIG_WINS_SERVERS</a> -<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * <a class="link" href="NMIP4Config.html#nm-ip4-config-new" title="nm_ip4_config_new ()">nm_ip4_config_new</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *connection</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *object_path</code></em>); -const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * <a class="link" href="NMIP4Config.html#nm-ip4-config-get-addresses" title="nm_ip4_config_get_addresses ()">nm_ip4_config_get_addresses</a> (<em class="parameter"><code><a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> *config</code></em>); -const <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="returnvalue">GArray</span></a> * <a class="link" href="NMIP4Config.html#nm-ip4-config-get-nameservers" title="nm_ip4_config_get_nameservers ()">nm_ip4_config_get_nameservers</a> (<em class="parameter"><code><a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> *config</code></em>); -const <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * <a class="link" href="NMIP4Config.html#nm-ip4-config-get-domains" title="nm_ip4_config_get_domains ()">nm_ip4_config_get_domains</a> (<em class="parameter"><code><a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> *config</code></em>); -const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * <a class="link" href="NMIP4Config.html#nm-ip4-config-get-routes" title="nm_ip4_config_get_routes ()">nm_ip4_config_get_routes</a> (<em class="parameter"><code><a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> *config</code></em>); -const <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="returnvalue">GArray</span></a> * <a class="link" href="NMIP4Config.html#nm-ip4-config-get-wins-servers" title="nm_ip4_config_get_wins_servers ()">nm_ip4_config_get_wins_servers</a> (<em class="parameter"><code><a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> *config</code></em>); -</pre> -</div> -<div class="refsect1"> -<a name="NMIP4Config.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="synopsis"> - <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> - +----<a class="link" href="NMObject.html" title="NMObject">NMObject</a> - +----NMIP4Config -</pre> -</div> -<div class="refsect1"> -<a name="NMIP4Config.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -NMIP4Config implements - <a href="http://library.gnome.org/devel/gio/unstable/GInitable.html">GInitable</a> and <a href="http://library.gnome.org/devel/gio/unstable/GAsyncInitable.html">GAsyncInitable</a>.</p> -</div> <div class="refsect1"> -<a name="NMIP4Config.properties"></a><h2>Properties</h2> -<pre class="synopsis"> - "<a class="link" href="NMIP4Config.html#NMIP4Config--addresses" title='The "addresses" property'>addresses</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> : Read - "<a class="link" href="NMIP4Config.html#NMIP4Config--domains" title='The "domains" property'>domains</a>" <span class="type">NMStringArray</span>* : Read - "<a class="link" href="NMIP4Config.html#NMIP4Config--nameservers" title='The "nameservers" property'>nameservers</a>" <span class="type">NMUintArray</span>* : Read - "<a class="link" href="NMIP4Config.html#NMIP4Config--routes" title='The "routes" property'>routes</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> : Read - "<a class="link" href="NMIP4Config.html#NMIP4Config--wins-servers" title='The "wins-servers" property'>wins-servers</a>" <span class="type">NMUintArray</span>* : Read -</pre> -</div> -<div class="refsect1"> -<a name="NMIP4Config.description"></a><h2>Description</h2> -<p> -</p> -</div> -<div class="refsect1"> -<a name="NMIP4Config.details"></a><h2>Details</h2> -<div class="refsect2"> -<a name="NMIP4Config-struct"></a><h3>NMIP4Config</h3> -<pre class="programlisting">typedef struct _NMIP4Config NMIP4Config;</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMIP4ConfigClass"></a><h3>NMIP4ConfigClass</h3> -<pre class="programlisting">typedef struct { - NMObjectClass parent; - - /* Padding for future expansion */ - void (*_reserved1) (void); - void (*_reserved2) (void); - void (*_reserved3) (void); - void (*_reserved4) (void); - void (*_reserved5) (void); - void (*_reserved6) (void); -} NMIP4ConfigClass; -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NM-IP4-CONFIG-ADDRESSES:CAPS"></a><h3>NM_IP4_CONFIG_ADDRESSES</h3> -<pre class="programlisting">#define NM_IP4_CONFIG_ADDRESSES "addresses" -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NM-IP4-CONFIG-NAMESERVERS:CAPS"></a><h3>NM_IP4_CONFIG_NAMESERVERS</h3> -<pre class="programlisting">#define NM_IP4_CONFIG_NAMESERVERS "nameservers" -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NM-IP4-CONFIG-DOMAINS:CAPS"></a><h3>NM_IP4_CONFIG_DOMAINS</h3> -<pre class="programlisting">#define NM_IP4_CONFIG_DOMAINS "domains" -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NM-IP4-CONFIG-ROUTES:CAPS"></a><h3>NM_IP4_CONFIG_ROUTES</h3> -<pre class="programlisting">#define NM_IP4_CONFIG_ROUTES "routes" -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NM-IP4-CONFIG-WINS-SERVERS:CAPS"></a><h3>NM_IP4_CONFIG_WINS_SERVERS</h3> -<pre class="programlisting">#define NM_IP4_CONFIG_WINS_SERVERS "wins-servers" -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="nm-ip4-config-new"></a><h3>nm_ip4_config_new ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * nm_ip4_config_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *connection</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *object_path</code></em>);</pre> -<p> -Creates a new <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a>. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="NMIP4Config.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="functions_return"> +<col class="functions_name"> </colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>the <a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> +<td class="function_type"> +<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * +</td> +<td class="function_name"> +<a class="link" href="NMIP4Config.html#nm-ip4-config-new" title="nm_ip4_config_new ()">nm_ip4_config_new</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td> -<td>the DBus object path of the device</td> +<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * +</td> +<td class="function_name"> +<a class="link" href="NMIP4Config.html#nm-ip4-config-get-addresses" title="nm_ip4_config_get_addresses ()">nm_ip4_config_get_addresses</a> <span class="c_punctuation">()</span> +</td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a new IP4 configuration. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="returnvalue">GArray</span></a> * +</td> +<td class="function_name"> +<a class="link" href="NMIP4Config.html#nm-ip4-config-get-nameservers" title="nm_ip4_config_get_nameservers ()">nm_ip4_config_get_nameservers</a> <span class="c_punctuation">()</span> </td> </tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="nm-ip4-config-get-addresses"></a><h3>nm_ip4_config_get_addresses ()</h3> -<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * nm_ip4_config_get_addresses (<em class="parameter"><code><a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> *config</code></em>);</pre> -<p> -Gets the IP4 addresses (containing the address, prefix, and gateway). -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> -<td>a <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> +<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * +</td> +<td class="function_name"> +<a class="link" href="NMIP4Config.html#nm-ip4-config-get-domains" title="nm_ip4_config_get_domains ()">nm_ip4_config_get_domains</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * +</td> +<td class="function_name"> +<a class="link" href="NMIP4Config.html#nm-ip4-config-get-routes" title="nm_ip4_config_get_routes ()">nm_ip4_config_get_routes</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> containing <a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/09/NMSettingIP4Config.html#NMIP4Address"><span class="type">NMIP4Address</span></a>es. -This is the internal copy used by the configuration and must not be modified. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NetworkManager.IP4Address]</span> +<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="returnvalue">GArray</span></a> * +</td> +<td class="function_name"> +<a class="link" href="NMIP4Config.html#nm-ip4-config-get-wins-servers" title="nm_ip4_config_get_wins_servers ()">nm_ip4_config_get_wins_servers</a> <span class="c_punctuation">()</span> </td> </tr> </tbody> </table></div> </div> -<hr> -<div class="refsect2"> -<a name="nm-ip4-config-get-nameservers"></a><h3>nm_ip4_config_get_nameservers ()</h3> -<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="returnvalue">GArray</span></a> * nm_ip4_config_get_nameservers (<em class="parameter"><code><a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> *config</code></em>);</pre> -<p> -Gets the domain name servers (DNS). -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<div class="refsect1"> +<a name="NMIP4Config.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> </colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> -<td>a <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> -</td> +<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td> +<td class="property_name"><a class="link" href="NMIP4Config.html#NMIP4Config--addresses" title="The “addresses” property">addresses</a></td> +<td class="property_flags">Read</td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="type">GArray</span></a> containing <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><code class="literal">guint32</code></a>s. This is the internal copy used by the -configuration and must not be modified. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint32]</span> -</td> +<td class="property_type"> +<span class="type">NMStringArray</span> *</td> +<td class="property_name"><a class="link" href="NMIP4Config.html#NMIP4Config--domains" title="The “domains” property">domains</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> +<span class="type">NMUintArray</span> *</td> +<td class="property_name"><a class="link" href="NMIP4Config.html#NMIP4Config--nameservers" title="The “nameservers” property">nameservers</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td> +<td class="property_name"><a class="link" href="NMIP4Config.html#NMIP4Config--routes" title="The “routes” property">routes</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> +<span class="type">NMUintArray</span> *</td> +<td class="property_name"><a class="link" href="NMIP4Config.html#NMIP4Config--wins-servers" title="The “wins-servers” property">wins-servers</a></td> +<td class="property_flags">Read</td> </tr> </tbody> </table></div> </div> -<hr> -<div class="refsect2"> -<a name="nm-ip4-config-get-domains"></a><h3>nm_ip4_config_get_domains ()</h3> -<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * nm_ip4_config_get_domains (<em class="parameter"><code><a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> *config</code></em>);</pre> -<p> -Gets the domain names. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<div class="refsect1"> +<a name="NMIP4Config.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="name"> +<col class="description"> </colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> -<td>a <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> -</td> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMIP4Config.html#NM-IP4-CONFIG-ADDRESSES:CAPS" title="NM_IP4_CONFIG_ADDRESSES">NM_IP4_CONFIG_ADDRESSES</a></td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing domains as strings. This is the -internal copy used by the configuration, and must not be modified. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span> -</td> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMIP4Config.html#NM-IP4-CONFIG-NAMESERVERS:CAPS" title="NM_IP4_CONFIG_NAMESERVERS">NM_IP4_CONFIG_NAMESERVERS</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMIP4Config.html#NM-IP4-CONFIG-DOMAINS:CAPS" title="NM_IP4_CONFIG_DOMAINS">NM_IP4_CONFIG_DOMAINS</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMIP4Config.html#NM-IP4-CONFIG-ROUTES:CAPS" title="NM_IP4_CONFIG_ROUTES">NM_IP4_CONFIG_ROUTES</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMIP4Config.html#NM-IP4-CONFIG-WINS-SERVERS:CAPS" title="NM_IP4_CONFIG_WINS_SERVERS">NM_IP4_CONFIG_WINS_SERVERS</a></td> </tr> </tbody> </table></div> </div> -<hr> -<div class="refsect2"> -<a name="nm-ip4-config-get-routes"></a><h3>nm_ip4_config_get_routes ()</h3> -<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * nm_ip4_config_get_routes (<em class="parameter"><code><a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> *config</code></em>);</pre> +<div class="refsect1"> +<a name="NMIP4Config.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> <a class="link" href="NMObject.html" title="NMObject">NMObject</a> + <span class="lineart">╰──</span> NMIP4Config +</pre> +</div> +<div class="refsect1"> +<a name="NMIP4Config.description"></a><h2>Description</h2> <p> -Gets the routes. </p> -<div class="variablelist"><table border="0" class="variablelist"> +</div> +<div class="refsect1"> +<a name="NMIP4Config.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="nm-ip4-config-new"></a><h3>nm_ip4_config_new ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * +nm_ip4_config_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *connection</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *object_path</code></em>);</pre> +<p>Creates a new <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a>.</p> +<div class="refsect3"> +<a name="id-1.3.18.8.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> -<td>a <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> -</td> +<td class="parameter_name"><p>connection</p></td> +<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a></p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> containing -<a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/09/NMSettingIP4Config.html#NMIP4Route"><span class="type">NMIP4Route</span></a>s. This is the internal copy used by the configuration, -and must not be modified. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NetworkManager.IP4Route]</span> -</td> +<td class="parameter_name"><p>object_path</p></td> +<td class="parameter_description"><p>the DBus object path of the device</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.3.18.8.2.6"></a><h4>Returns</h4> +<p> a new IP4 configuration. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> <hr> <div class="refsect2"> -<a name="nm-ip4-config-get-wins-servers"></a><h3>nm_ip4_config_get_wins_servers ()</h3> -<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="returnvalue">GArray</span></a> * nm_ip4_config_get_wins_servers (<em class="parameter"><code><a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> *config</code></em>);</pre> -<p> -Gets the Windows Internet Name Service servers (WINS). -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="nm-ip4-config-get-addresses"></a><h3>nm_ip4_config_get_addresses ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * +nm_ip4_config_get_addresses (<em class="parameter"><code><a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> *config</code></em>);</pre> +<p>Gets the IP4 addresses (containing the address, prefix, and gateway).</p> +<div class="refsect3"> +<a name="id-1.3.18.8.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> </colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> -<td>a <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="type">GArray</span></a> containing <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><code class="literal">guint32</code></a>s. -This is the internal copy used by the configuration and must not be modified. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint32]</span> -</td> -</tr> -</tbody> +<tbody><tr> +<td class="parameter_name"><p>config</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.18.8.3.6"></a><h4>Returns</h4> +<p> the <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> containing <a href="https://developer.gnome.org/libnm-util/0.9/NMSettingIP4Config.html#NMIP4Address"><span class="type">NMIP4Address</span></a>es. +This is the internal copy used by the configuration and must not be modified. </p> +<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NetworkManager.IP4Address]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-ip4-config-get-nameservers"></a><h3>nm_ip4_config_get_nameservers ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="returnvalue">GArray</span></a> * +nm_ip4_config_get_nameservers (<em class="parameter"><code><a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> *config</code></em>);</pre> +<p>Gets the domain name servers (DNS).</p> +<div class="refsect3"> +<a name="id-1.3.18.8.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>config</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.18.8.4.6"></a><h4>Returns</h4> +<p> the <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="type">GArray</span></a> containing <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><code class="literal">guint32</code></a>s. This is the internal copy used by the +configuration and must not be modified. </p> +<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint32]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-ip4-config-get-domains"></a><h3>nm_ip4_config_get_domains ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * +nm_ip4_config_get_domains (<em class="parameter"><code><a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> *config</code></em>);</pre> +<p>Gets the domain names.</p> +<div class="refsect3"> +<a name="id-1.3.18.8.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>config</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.18.8.5.6"></a><h4>Returns</h4> +<p> the <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing domains as strings. This is the +internal copy used by the configuration, and must not be modified. </p> +<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-ip4-config-get-routes"></a><h3>nm_ip4_config_get_routes ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * +nm_ip4_config_get_routes (<em class="parameter"><code><a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> *config</code></em>);</pre> +<p>Gets the routes.</p> +<div class="refsect3"> +<a name="id-1.3.18.8.6.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>config</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.3.18.8.6.6"></a><h4>Returns</h4> +<p> the <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> containing +<a href="https://developer.gnome.org/libnm-util/0.9/NMSettingIP4Config.html#NMIP4Route"><span class="type">NMIP4Route</span></a>s. This is the internal copy used by the configuration, +and must not be modified. </p> +<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NetworkManager.IP4Route]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-ip4-config-get-wins-servers"></a><h3>nm_ip4_config_get_wins_servers ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="returnvalue">GArray</span></a> * +nm_ip4_config_get_wins_servers (<em class="parameter"><code><a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> *config</code></em>);</pre> +<p>Gets the Windows Internet Name Service servers (WINS).</p> +<div class="refsect3"> +<a name="id-1.3.18.8.7.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>config</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.18.8.7.6"></a><h4>Returns</h4> +<p> the <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="type">GArray</span></a> containing <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><code class="literal">guint32</code></a>s. +This is the internal copy used by the configuration and must not be modified. </p> +<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint32]</span></p> +</div> +</div> </div> <div class="refsect1"> -<a name="NMIP4Config.property-details"></a><h2>Property Details</h2> +<a name="NMIP4Config.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> -<a name="NMIP4Config--addresses"></a><h3>The <code class="literal">"addresses"</code> property</h3> -<pre class="programlisting"> "addresses" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> : Read</pre> +<a name="NM-IP4-CONFIG-ADDRESSES:CAPS"></a><h3>NM_IP4_CONFIG_ADDRESSES</h3> +<pre class="programlisting">#define NM_IP4_CONFIG_ADDRESSES "addresses" +</pre> <p> -The <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing <span class="type">NMSettingIP4Address</span>es of the configuration. </p> </div> <hr> <div class="refsect2"> -<a name="NMIP4Config--domains"></a><h3>The <code class="literal">"domains"</code> property</h3> -<pre class="programlisting"> "domains" <span class="type">NMStringArray</span>* : Read</pre> +<a name="NM-IP4-CONFIG-NAMESERVERS:CAPS"></a><h3>NM_IP4_CONFIG_NAMESERVERS</h3> +<pre class="programlisting">#define NM_IP4_CONFIG_NAMESERVERS "nameservers" +</pre> <p> -The <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing domain strings of the configuration. </p> </div> <hr> <div class="refsect2"> -<a name="NMIP4Config--nameservers"></a><h3>The <code class="literal">"nameservers"</code> property</h3> -<pre class="programlisting"> "nameservers" <span class="type">NMUintArray</span>* : Read</pre> +<a name="NM-IP4-CONFIG-DOMAINS:CAPS"></a><h3>NM_IP4_CONFIG_DOMAINS</h3> +<pre class="programlisting">#define NM_IP4_CONFIG_DOMAINS "domains" +</pre> <p> -The <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="type">GArray</span></a> containing name servers (<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><code class="literal">guint32</code></a>es) of the configuration. </p> </div> <hr> <div class="refsect2"> -<a name="NMIP4Config--routes"></a><h3>The <code class="literal">"routes"</code> property</h3> -<pre class="programlisting"> "routes" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> : Read</pre> +<a name="NM-IP4-CONFIG-ROUTES:CAPS"></a><h3>NM_IP4_CONFIG_ROUTES</h3> +<pre class="programlisting">#define NM_IP4_CONFIG_ROUTES "routes" +</pre> <p> -The <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing <span class="type">NMSettingIP4Route</span>s of the configuration. </p> </div> <hr> <div class="refsect2"> -<a name="NMIP4Config--wins-servers"></a><h3>The <code class="literal">"wins-servers"</code> property</h3> -<pre class="programlisting"> "wins-servers" <span class="type">NMUintArray</span>* : Read</pre> +<a name="NM-IP4-CONFIG-WINS-SERVERS:CAPS"></a><h3>NM_IP4_CONFIG_WINS_SERVERS</h3> +<pre class="programlisting">#define NM_IP4_CONFIG_WINS_SERVERS "wins-servers" +</pre> <p> -The <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="type">GArray</span></a> containing WINS servers (<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><code class="literal">guint32</code></a>es) of the configuration. </p> </div> </div> +<div class="refsect1"> +<a name="NMIP4Config.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="NMIP4Config--addresses"></a><h3>The <code class="literal">“addresses”</code> property</h3> +<pre class="programlisting"> “addresses” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre> +<p>Addresses.</p> +<p>Flags: Read</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMIP4Config--domains"></a><h3>The <code class="literal">“domains”</code> property</h3> +<pre class="programlisting"> “domains” <span class="type">NMStringArray</span> *</pre> +<p>Domains.</p> +<p>Flags: Read</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMIP4Config--nameservers"></a><h3>The <code class="literal">“nameservers”</code> property</h3> +<pre class="programlisting"> “nameservers” <span class="type">NMUintArray</span> *</pre> +<p>Nameservers.</p> +<p>Flags: Read</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMIP4Config--routes"></a><h3>The <code class="literal">“routes”</code> property</h3> +<pre class="programlisting"> “routes” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre> +<p>Routes.</p> +<p>Flags: Read</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMIP4Config--wins-servers"></a><h3>The <code class="literal">“wins-servers”</code> property</h3> +<pre class="programlisting"> “wins-servers” <span class="type">NMUintArray</span> *</pre> +<p>WINS Servers.</p> +<p>Flags: Read</p> +</div> +</div> </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.19</div> + Generated by GTK-Doc V1.20</div> </body> </html> \ No newline at end of file |