diff options
| author | Michael Biebl <biebl@debian.org> | 2010-11-29 00:47:11 +0100 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2010-11-29 00:47:11 +0100 |
| commit | 9fae01fa351805b2903e535736e06971bc0b925e (patch) | |
| tree | c19bccf84c9f894e50fae678ba6ee2b2044e2d30 /docs/libnm-glib/html/NMIP6Config.html | |
Imported Upstream version 0.8.1 upstream/0.8.1
Diffstat (limited to 'docs/libnm-glib/html/NMIP6Config.html')
| -rw-r--r-- | docs/libnm-glib/html/NMIP6Config.html | 290 |
1 files changed, 290 insertions, 0 deletions
diff --git a/docs/libnm-glib/html/NMIP6Config.html b/docs/libnm-glib/html/NMIP6Config.html new file mode 100644 index 00000000..738699ba --- /dev/null +++ b/docs/libnm-glib/html/NMIP6Config.html @@ -0,0 +1,290 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMIP6Config</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="libnm-glib Reference Manual"> +<link rel="up" href="ch01.html" title="libnm-glib Objects"> +<link rel="prev" href="NMIP4Config.html" title="NMIP4Config"> +<link rel="next" href="NMDHCP4Config.html" title="NMDHCP4Config"> +<meta name="generator" content="GTK-Doc V1.14 (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="NMIP4Config.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.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="NMDHCP4Config.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#NMIP6Config.synopsis" class="shortcut">Top</a> + | + <a href="#NMIP6Config.description" class="shortcut">Description</a> + | + <a href="#NMIP6Config.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#NMIP6Config.properties" class="shortcut">Properties</a> +</td></tr> +</table> +<div class="refentry" title="NMIP6Config"> +<a name="NMIP6Config"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="NMIP6Config.top_of_page"></a>NMIP6Config</span></h2> +<p>NMIP6Config</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="NMIP6Config.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> <a class="link" href="NMIP6Config.html#NMIP6Config-struct" title="NMIP6Config">NMIP6Config</a>; +#define <a class="link" href="NMIP6Config.html#NM-IP6-CONFIG-ADDRESSES:CAPS" title="NM_IP6_CONFIG_ADDRESSES">NM_IP6_CONFIG_ADDRESSES</a> +#define <a class="link" href="NMIP6Config.html#NM-IP6-CONFIG-NAMESERVERS:CAPS" title="NM_IP6_CONFIG_NAMESERVERS">NM_IP6_CONFIG_NAMESERVERS</a> +#define <a class="link" href="NMIP6Config.html#NM-IP6-CONFIG-DOMAINS:CAPS" title="NM_IP6_CONFIG_DOMAINS">NM_IP6_CONFIG_DOMAINS</a> +#define <a class="link" href="NMIP6Config.html#NM-IP6-CONFIG-ROUTES:CAPS" title="NM_IP6_CONFIG_ROUTES">NM_IP6_CONFIG_ROUTES</a> +<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * <a class="link" href="NMIP6Config.html#nm-ip6-config-new" title="nm_ip6_config_new ()">nm_ip6_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="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * <a class="link" href="NMIP6Config.html#nm-ip6-config-get-addresses" title="nm_ip6_config_get_addresses ()">nm_ip6_config_get_addresses</a> (<em class="parameter"><code><a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> *config</code></em>); +const <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * <a class="link" href="NMIP6Config.html#nm-ip6-config-get-nameservers" title="nm_ip6_config_get_nameservers ()">nm_ip6_config_get_nameservers</a> (<em class="parameter"><code><a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> *config</code></em>); +const <a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * <a class="link" href="NMIP6Config.html#nm-ip6-config-get-domains" title="nm_ip6_config_get_domains ()">nm_ip6_config_get_domains</a> (<em class="parameter"><code><a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> *config</code></em>); +const <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * <a class="link" href="NMIP6Config.html#nm-ip6-config-get-routes" title="nm_ip6_config_get_routes ()">nm_ip6_config_get_routes</a> (<em class="parameter"><code><a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> *config</code></em>); +</pre> +</div> +<div class="refsect1" title="Object Hierarchy"> +<a name="NMIP6Config.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----<a class="link" href="libnm-glib-nm-object.html#NMObject">NMObject</a> + +----NMIP6Config +</pre> +</div> +<div class="refsect1" title="Properties"> +<a name="NMIP6Config.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="NMIP6Config.html#NMIP6Config--addresses" title='The "addresses" property'>addresses</a>" <span class="type">nm-ip6-address-object-array*</span> : Read + "<a class="link" href="NMIP6Config.html#NMIP6Config--domains" title='The "domains" property'>domains</a>" <span class="type">nm-string-array*</span> : Read + "<a class="link" href="NMIP6Config.html#NMIP6Config--nameservers" title='The "nameservers" property'>nameservers</a>" <span class="type">nm-ip6-address-array*</span> : Read + "<a class="link" href="NMIP6Config.html#NMIP6Config--routes" title='The "routes" property'>routes</a>" <span class="type">nm-ip6-route-object-array*</span> : Read +</pre> +</div> +<div class="refsect1" title="Description"> +<a name="NMIP6Config.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1" title="Details"> +<a name="NMIP6Config.details"></a><h2>Details</h2> +<div class="refsect2" title="NMIP6Config"> +<a name="NMIP6Config-struct"></a><h3>NMIP6Config</h3> +<pre class="programlisting">typedef struct _NMIP6Config NMIP6Config;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="NM_IP6_CONFIG_ADDRESSES"> +<a name="NM-IP6-CONFIG-ADDRESSES:CAPS"></a><h3>NM_IP6_CONFIG_ADDRESSES</h3> +<pre class="programlisting">#define NM_IP6_CONFIG_ADDRESSES "addresses" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="NM_IP6_CONFIG_NAMESERVERS"> +<a name="NM-IP6-CONFIG-NAMESERVERS:CAPS"></a><h3>NM_IP6_CONFIG_NAMESERVERS</h3> +<pre class="programlisting">#define NM_IP6_CONFIG_NAMESERVERS "nameservers" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="NM_IP6_CONFIG_DOMAINS"> +<a name="NM-IP6-CONFIG-DOMAINS:CAPS"></a><h3>NM_IP6_CONFIG_DOMAINS</h3> +<pre class="programlisting">#define NM_IP6_CONFIG_DOMAINS "domains" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="NM_IP6_CONFIG_ROUTES"> +<a name="NM-IP6-CONFIG-ROUTES:CAPS"></a><h3>NM_IP6_CONFIG_ROUTES</h3> +<pre class="programlisting">#define NM_IP6_CONFIG_ROUTES "routes" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="nm_ip6_config_new ()"> +<a name="nm-ip6-config-new"></a><h3>nm_ip6_config_new ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * nm_ip6_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="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<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> +</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> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> a new IP6 configuration +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_ip6_config_get_addresses ()"> +<a name="nm-ip6-config-get-addresses"></a><h3>nm_ip6_config_get_addresses ()</h3> +<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * nm_ip6_config_get_addresses (<em class="parameter"><code><a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> *config</code></em>);</pre> +<p> +Gets the IP6 addresses (containing the address, prefix, and gateway). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> +<td>a <a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> containing <span class="type">NMSettingIP6Address</span>es. This is the internal copy +used by the configuration and must not be modified. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_ip6_config_get_nameservers ()"> +<a name="nm-ip6-config-get-nameservers"></a><h3>nm_ip6_config_get_nameservers ()</h3> +<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * nm_ip6_config_get_nameservers (<em class="parameter"><code><a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> *config</code></em>);</pre> +<p> +Gets the domain name servers (DNS). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> +<td>a <a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> a <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> containing elements of type 'struct in6_addr' which contain +the addresses of nameservers of the configuration. This is the internal copy +used by the configuration and must not be modified. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_ip6_config_get_domains ()"> +<a name="nm-ip6-config-get-domains"></a><h3>nm_ip6_config_get_domains ()</h3> +<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * nm_ip6_config_get_domains (<em class="parameter"><code><a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> *config</code></em>);</pre> +<p> +Gets the domain names. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> +<td>a <a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the <a href="/usr/share/gtk-doc/html/glib/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. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_ip6_config_get_routes ()"> +<a name="nm-ip6-config-get-routes"></a><h3>nm_ip6_config_get_routes ()</h3> +<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * nm_ip6_config_get_routes (<em class="parameter"><code><a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> *config</code></em>);</pre> +<p> +Gets the routes. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> +<td>a <a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> containing <span class="type">NMSettingIP6Route</span>s. This is the +internal copy used by the configuration, and must not be modified. +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1" title="Property Details"> +<a name="NMIP6Config.property-details"></a><h2>Property Details</h2> +<div class="refsect2" title='The "addresses" property'> +<a name="NMIP6Config--addresses"></a><h3>The <code class="literal">"addresses"</code> property</h3> +<pre class="programlisting"> "addresses" <span class="type">nm-ip6-address-object-array*</span> : Read</pre> +<p> +The <a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing the IPv6 addresses; use +<a href="/usr/share/gtk-doc/html/libnm-util/libnm-util-nm-utils.html#nm-utils-ip6-addresses-from-gvalue"><code class="function">nm_utils_ip6_addresses_from_gvalue()</code></a> to return a <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of +<span class="type">NMSettingIP6Address</span> objects that is more usable than the raw data. +</p> +</div> +<hr> +<div class="refsect2" title='The "domains" property'> +<a name="NMIP6Config--domains"></a><h3>The <code class="literal">"domains"</code> property</h3> +<pre class="programlisting"> "domains" <span class="type">nm-string-array*</span> : Read</pre> +<p> +The <a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing domain strings of the configuration. +</p> +</div> +<hr> +<div class="refsect2" title='The "nameservers" property'> +<a name="NMIP6Config--nameservers"></a><h3>The <code class="literal">"nameservers"</code> property</h3> +<pre class="programlisting"> "nameservers" <span class="type">nm-ip6-address-array*</span> : Read</pre> +<p> +The <a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing elements of type 'struct ip6_addr' which +contain the addresses of nameservers of the configuration. +</p> +</div> +<hr> +<div class="refsect2" title='The "routes" property'> +<a name="NMIP6Config--routes"></a><h3>The <code class="literal">"routes"</code> property</h3> +<pre class="programlisting"> "routes" <span class="type">nm-ip6-route-object-array*</span> : Read</pre> +<p> +The <a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing the IPv6 routes; use +<a href="/usr/share/gtk-doc/html/libnm-util/libnm-util-nm-utils.html#nm-utils-ip6-routes-from-gvalue"><code class="function">nm_utils_ip6_routes_from_gvalue()</code></a> to return a <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of +<span class="type">NMSettingIP6Address</span> objects that is more usable than the raw data. +</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.14</div> +</body> +</html> \ No newline at end of file |