diff options
Diffstat (limited to 'docs/libnm/html/NMDhcpConfig.html')
| -rw-r--r-- | docs/libnm/html/NMDhcpConfig.html | 232 |
1 files changed, 232 insertions, 0 deletions
diff --git a/docs/libnm/html/NMDhcpConfig.html b/docs/libnm/html/NMDhcpConfig.html new file mode 100644 index 00000000..3a48d730 --- /dev/null +++ b/docs/libnm/html/NMDhcpConfig.html @@ -0,0 +1,232 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMDhcpConfig</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="libnm Reference Manual"> +<link rel="up" href="ch04.html" title="Device and Runtime Configuration API Reference"> +<link rel="prev" href="NMIPConfig.html" title="NMIPConfig"> +<link rel="next" href="ch05.html" title="Utility API Reference"> +<meta name="generator" content="GTK-Doc V1.19 (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="NMIPConfig.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch04.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 Reference Manual</th> +<td><a accesskey="n" href="ch05.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#NMDhcpConfig.synopsis" class="shortcut">Top</a> + | + <a href="#NMDhcpConfig.description" class="shortcut">Description</a> + | + <a href="#NMDhcpConfig.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#NMDhcpConfig.implemented-interfaces" class="shortcut">Implemented Interfaces</a> + | + <a href="#NMDhcpConfig.properties" class="shortcut">Properties</a> +</td></tr> +</table> +<div class="refentry"> +<a name="NMDhcpConfig"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="NMDhcpConfig.top_of_page"></a>NMDhcpConfig</span></h2> +<p>NMDhcpConfig</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="NMDhcpConfig.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="NMDhcpConfig.html#NMDhcpConfig-struct" title="struct NMDhcpConfig">NMDhcpConfig</a>; + <a class="link" href="NMDhcpConfig.html#NMDhcpConfigClass" title="NMDhcpConfigClass">NMDhcpConfigClass</a>; +#define <a class="link" href="NMDhcpConfig.html#NM-DHCP-CONFIG-FAMILY:CAPS" title="NM_DHCP_CONFIG_FAMILY">NM_DHCP_CONFIG_FAMILY</a> +#define <a class="link" href="NMDhcpConfig.html#NM-DHCP-CONFIG-OPTIONS:CAPS" title="NM_DHCP_CONFIG_OPTIONS">NM_DHCP_CONFIG_OPTIONS</a> +<span class="returnvalue">int</span> <a class="link" href="NMDhcpConfig.html#nm-dhcp-config-get-family" title="nm_dhcp_config_get_family ()">nm_dhcp_config_get_family</a> (<em class="parameter"><code><a class="link" href="NMDhcpConfig.html" title="NMDhcpConfig"><span class="type">NMDhcpConfig</span></a> *config</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * <a class="link" href="NMDhcpConfig.html#nm-dhcp-config-get-options" title="nm_dhcp_config_get_options ()">nm_dhcp_config_get_options</a> (<em class="parameter"><code><a class="link" href="NMDhcpConfig.html" title="NMDhcpConfig"><span class="type">NMDhcpConfig</span></a> *config</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMDhcpConfig.html#nm-dhcp-config-get-one-option" title="nm_dhcp_config_get_one_option ()">nm_dhcp_config_get_one_option</a> (<em class="parameter"><code><a class="link" href="NMDhcpConfig.html" title="NMDhcpConfig"><span class="type">NMDhcpConfig</span></a> *config</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *option</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="NMDhcpConfig.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> + +----NMDhcpConfig +</pre> +</div> +<div class="refsect1"> +<a name="NMDhcpConfig.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +NMDhcpConfig 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="NMDhcpConfig.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="NMDhcpConfig.html#NMDhcpConfig--family" title='The "family" property'>family</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read + "<a class="link" href="NMDhcpConfig.html#NMDhcpConfig--options" title='The "options" property'>options</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a>* : Read +</pre> +</div> +<div class="refsect1"> +<a name="NMDhcpConfig.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1"> +<a name="NMDhcpConfig.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="NMDhcpConfig-struct"></a><h3>struct NMDhcpConfig</h3> +<pre class="programlisting">struct NMDhcpConfig;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDhcpConfigClass"></a><h3>NMDhcpConfigClass</h3> +<pre class="programlisting">typedef struct { + NMObjectClass parent; +} NMDhcpConfigClass; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-DHCP-CONFIG-FAMILY:CAPS"></a><h3>NM_DHCP_CONFIG_FAMILY</h3> +<pre class="programlisting">#define NM_DHCP_CONFIG_FAMILY "family" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-DHCP-CONFIG-OPTIONS:CAPS"></a><h3>NM_DHCP_CONFIG_OPTIONS</h3> +<pre class="programlisting">#define NM_DHCP_CONFIG_OPTIONS "options" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-dhcp-config-get-family"></a><h3>nm_dhcp_config_get_family ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> nm_dhcp_config_get_family (<em class="parameter"><code><a class="link" href="NMDhcpConfig.html" title="NMDhcpConfig"><span class="type">NMDhcpConfig</span></a> *config</code></em>);</pre> +<p> +Gets the IP address family of the configuration +</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="NMDhcpConfig.html" title="NMDhcpConfig"><span class="type">NMDhcpConfig</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the IP address family; either <code class="literal">AF_INET</code> or +<code class="literal">AF_INET6</code> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-dhcp-config-get-options"></a><h3>nm_dhcp_config_get_options ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * nm_dhcp_config_get_options (<em class="parameter"><code><a class="link" href="NMDhcpConfig.html" title="NMDhcpConfig"><span class="type">NMDhcpConfig</span></a> *config</code></em>);</pre> +<p> +Gets all the options contained in the configuration. +</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="NMDhcpConfig.html" title="NMDhcpConfig"><span class="type">NMDhcpConfig</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-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> containing +strings for keys and values. This is the internal copy used by the +configuration, and must not be modified. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 utf8]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-dhcp-config-get-one-option"></a><h3>nm_dhcp_config_get_one_option ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_dhcp_config_get_one_option (<em class="parameter"><code><a class="link" href="NMDhcpConfig.html" title="NMDhcpConfig"><span class="type">NMDhcpConfig</span></a> *config</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *option</code></em>);</pre> +<p> +Gets one option by option name. +</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="NMDhcpConfig.html" title="NMDhcpConfig"><span class="type">NMDhcpConfig</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>option</code></em> :</span></p></td> +<td>the option to retrieve</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the configuration option's value. This is the internal string used by the +configuration, and must not be modified.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="NMDhcpConfig.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="NMDhcpConfig--family"></a><h3>The <code class="literal">"family"</code> property</h3> +<pre class="programlisting"> "family" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read</pre> +<p> +The IP address family of the configuration; either +<code class="literal">AF_INET</code> or <code class="literal">AF_INET6</code>. +</p> +<p>Allowed values: [0,255]</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDhcpConfig--options"></a><h3>The <code class="literal">"options"</code> property</h3> +<pre class="programlisting"> "options" <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a>* : Read</pre> +<p> +The <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> containing options of the configuration. +</p> +<p> +Type: GLib.HashTable(utf8,utf8) +</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19</div> +</body> +</html> \ No newline at end of file |