diff options
Diffstat (limited to 'docs/libnm/html/NMIPConfig.html')
| -rw-r--r-- | docs/libnm/html/NMIPConfig.html | 165 |
1 files changed, 155 insertions, 10 deletions
diff --git a/docs/libnm/html/NMIPConfig.html b/docs/libnm/html/NMIPConfig.html index b3d4adbf..245c2e79 100644 --- a/docs/libnm/html/NMIPConfig.html +++ b/docs/libnm/html/NMIPConfig.html @@ -8,14 +8,16 @@ <link rel="up" href="ch04.html" title="Device and Runtime Configuration API Reference"> <link rel="prev" href="NMWimaxNsp.html" title="NMWimaxNsp"> <link rel="next" href="NMDhcpConfig.html" title="NMDhcpConfig"> -<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.33.1 (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="5"><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="#NMIPConfig.description" class="shortcut">Description</a></span> + <a href="#NMIPConfig.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#NMIPConfig.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#NMIPConfig.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="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> @@ -102,6 +104,61 @@ </table></div> </div> <div class="refsect1"> +<a name="NMIPConfig.properties"></a><h2>Properties</h2> +<div class="informaltable"><table class="informaltable" border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *</td> +<td class="property_name"><a class="link" href="NMIPConfig.html#NMIPConfig--addresses" title="The “addresses” property">addresses</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></td> +<td class="property_name"><a class="link" href="NMIPConfig.html#NMIPConfig--domains" title="The “domains” property">domains</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><span class="type">int</span></td> +<td class="property_name"><a class="link" href="NMIPConfig.html#NMIPConfig--family" title="The “family” property">family</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> +<span class="type">char</span> *</td> +<td class="property_name"><a class="link" href="NMIPConfig.html#NMIPConfig--gateway" title="The “gateway” property">gateway</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></td> +<td class="property_name"><a class="link" href="NMIPConfig.html#NMIPConfig--nameservers" title="The “nameservers” property">nameservers</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *</td> +<td class="property_name"><a class="link" href="NMIPConfig.html#NMIPConfig--routes" title="The “routes” property">routes</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></td> +<td class="property_name"><a class="link" href="NMIPConfig.html#NMIPConfig--searches" title="The “searches” property">searches</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></td> +<td class="property_name"><a class="link" href="NMIPConfig.html#NMIPConfig--wins-servers" title="The “wins-servers” property">wins-servers</a></td> +<td class="property_flags">Read</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> <a name="NMIPConfig.other"></a><h2>Types and Values</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> @@ -141,10 +198,21 @@ <td class="define_keyword">#define</td> <td class="function_name"><a class="link" href="NMIPConfig.html#NM-IP-CONFIG-WINS-SERVERS:CAPS" title="NM_IP_CONFIG_WINS_SERVERS">NM_IP_CONFIG_WINS_SERVERS</a></td> </tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="NMIPConfig.html#NMIPConfig-struct" title="NMIPConfig">NMIPConfig</a></td> +</tr> </tbody> </table></div> </div> <div class="refsect1"> +<a name="NMIPConfig.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> + <span class="lineart">╰──</span> <a class="link" href="NMObject.html" title="NMObject">NMObject</a> + <span class="lineart">╰──</span> NMIPConfig +</pre> +</div> +<div class="refsect1"> <a name="NMIPConfig.description"></a><h2>Description</h2> </div> <div class="refsect1"> @@ -199,7 +267,7 @@ nm_ip_config_get_gateway (<em class="parameter"><code><a class="link" href="NMIP <div class="refsect3"> <a name="nm-ip-config-get-gateway.returns"></a><h4>Returns</h4> <p>the IP address of the gateway. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p> </div> </div> <hr> @@ -229,7 +297,7 @@ nm_ip_config_get_addresses (<em class="parameter"><code><a class="link" href="NM containing <a class="link" href="NMSettingIPConfig.html#NMIPAddress"><span class="type">NMIPAddress</span></a>es. This is the internal copy used by the configuration and must not be modified. The library never modifies the returned array and thus it is safe for callers to reference and keep using it. </p> -<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NMIPAddress][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NMIPAddress][<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p> </div> </div> <hr> @@ -259,7 +327,7 @@ nm_ip_config_get_routes (<em class="parameter"><code><a class="link" href="NMIPC <a class="link" href="NMSettingIPConfig.html#NMIPRoute"><span class="type">NMIPRoute</span></a>s. This is the internal copy used by the configuration, and must not be modified. The library never modifies the returned array and thus it is safe for callers to reference and keep using it. </p> -<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NMIPRoute][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NMIPRoute][<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p> </div> </div> <hr> @@ -286,7 +354,7 @@ nm_ip_config_get_nameservers (<em class="parameter"><code><a class="link" href=" <div class="refsect3"> <a name="nm-ip-config-get-nameservers.returns"></a><h4>Returns</h4> <p>the array of nameserver IP addresses. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p> </div> </div> <hr> @@ -314,7 +382,7 @@ nm_ip_config_get_domains (<em class="parameter"><code><a class="link" href="NMIP <a name="nm-ip-config-get-domains.returns"></a><h4>Returns</h4> <p>the array of domains. (This is never <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, though it may be 0-length). </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p> </div> </div> <hr> @@ -342,7 +410,7 @@ nm_ip_config_get_searches (<em class="parameter"><code><a class="link" href="NMI <a name="nm-ip-config-get-searches.returns"></a><h4>Returns</h4> <p>the array of DNS search strings. (This is never <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, though it may be 0-length). </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p> </div> </div> <hr> @@ -370,7 +438,7 @@ nm_ip_config_get_wins_servers (<em class="parameter"><code><a class="link" href= <a name="nm-ip-config-get-wins-servers.returns"></a><h4>Returns</h4> <p>the arry of WINS server IP address strings. (This is never <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, though it may be 0-length.). </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p> </div> </div> </div> @@ -423,9 +491,86 @@ nm_ip_config_get_wins_servers (<em class="parameter"><code><a class="link" href= <pre class="programlisting">#define NM_IP_CONFIG_WINS_SERVERS "wins-servers" </pre> </div> +<hr> +<div class="refsect2"> +<a name="NMIPConfig-struct"></a><h3>NMIPConfig</h3> +<pre class="programlisting">typedef struct _NMIPConfig NMIPConfig;</pre> +</div> +</div> +<div class="refsect1"> +<a name="NMIPConfig.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="NMIPConfig--addresses"></a><h3>The <code class="literal">“addresses”</code> property</h3> +<pre class="programlisting"> “addresses” <a href="https://developer.gnome.org/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *</pre> +<p>A <a href="https://developer.gnome.org/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing the addresses (<a class="link" href="NMSettingIPConfig.html#NMIPAddress"><span class="type">NMIPAddress</span></a>) of the configuration.</p> +<p>Owner: NMIPConfig</p> +<p>Flags: Read</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMIPConfig--domains"></a><h3>The <code class="literal">“domains”</code> property</h3> +<pre class="programlisting"> “domains” <a href="https://developer.gnome.org/glib/unstable/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></pre> +<p>The array containing domain strings of the configuration.</p> +<p>Owner: NMIPConfig</p> +<p>Flags: Read</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMIPConfig--family"></a><h3>The <code class="literal">“family”</code> property</h3> +<pre class="programlisting"> “family” <span class="type">int</span></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>Owner: NMIPConfig</p> +<p>Flags: Read</p> +<p>Allowed values: [0,255]</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMIPConfig--gateway"></a><h3>The <code class="literal">“gateway”</code> property</h3> +<pre class="programlisting"> “gateway” <span class="type">char</span> *</pre> +<p>The IP gateway address of the configuration as string.</p> +<p>Owner: NMIPConfig</p> +<p>Flags: Read</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMIPConfig--nameservers"></a><h3>The <code class="literal">“nameservers”</code> property</h3> +<pre class="programlisting"> “nameservers” <a href="https://developer.gnome.org/glib/unstable/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></pre> +<p>The array containing name server IP addresses of the configuration.</p> +<p>Owner: NMIPConfig</p> +<p>Flags: Read</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMIPConfig--routes"></a><h3>The <code class="literal">“routes”</code> property</h3> +<pre class="programlisting"> “routes” <a href="https://developer.gnome.org/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *</pre> +<p>A <a href="https://developer.gnome.org/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing the routes (<a class="link" href="NMSettingIPConfig.html#NMIPRoute"><span class="type">NMIPRoute</span></a>) of the configuration.</p> +<p><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GPtrArray(NMIPRoute)]</span></p> +<p>Owner: NMIPConfig</p> +<p>Flags: Read</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMIPConfig--searches"></a><h3>The <code class="literal">“searches”</code> property</h3> +<pre class="programlisting"> “searches” <a href="https://developer.gnome.org/glib/unstable/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></pre> +<p>The array containing DNS search strings of the configuration.</p> +<p>Owner: NMIPConfig</p> +<p>Flags: Read</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMIPConfig--wins-servers"></a><h3>The <code class="literal">“wins-servers”</code> property</h3> +<pre class="programlisting"> “wins-servers” <a href="https://developer.gnome.org/glib/unstable/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></pre> +<p>The array containing WINS server IP addresses of the configuration. +(This will always be empty for IPv6 configurations.)</p> +<p>Owner: NMIPConfig</p> +<p>Flags: Read</p> +</div> </div> </div> <div class="footer"> -<hr>Generated by GTK-Doc V1.33.0</div> +<hr>Generated by GTK-Doc V1.33.1</div> </body> </html> \ No newline at end of file |