about summary refs log tree commit diff
path: root/docs/libnm/html/NMIPConfig.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libnm/html/NMIPConfig.html')
-rw-r--r--docs/libnm/html/NMIPConfig.html38
1 files changed, 20 insertions, 18 deletions
diff --git a/docs/libnm/html/NMIPConfig.html b/docs/libnm/html/NMIPConfig.html
index 9a32ecb6..b21fc882 100644
--- a/docs/libnm/html/NMIPConfig.html
+++ b/docs/libnm/html/NMIPConfig.html
@@ -219,7 +219,7 @@
 nm_ip_config_get_family (<em class="parameter"><code><a class="link" href="NMIPConfig.html" title="NMIPConfig"><span class="type">NMIPConfig</span></a> *config</code></em>);</pre>
 <p>Gets the IP address family</p>
 <div class="refsect3">
-<a name="id-1.5.21.8.2.5"></a><h4>Parameters</h4>
+<a name="id-1.5.25.8.2.5"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -234,7 +234,7 @@ nm_ip_config_get_family (<em class="parameter"><code><a class="link" href="NMIPC
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.5.21.8.2.6"></a><h4>Returns</h4>
+<a name="id-1.5.25.8.2.6"></a><h4>Returns</h4>
 <p> the IP address family; either <code class="literal">AF_INET</code> or
 <code class="literal">AF_INET6</code></p>
 </div>
@@ -246,7 +246,7 @@ nm_ip_config_get_family (<em class="parameter"><code><a class="link" href="NMIPC
 nm_ip_config_get_gateway (<em class="parameter"><code><a class="link" href="NMIPConfig.html" title="NMIPConfig"><span class="type">NMIPConfig</span></a> *config</code></em>);</pre>
 <p>Gets the IP gateway address.</p>
 <div class="refsect3">
-<a name="id-1.5.21.8.3.5"></a><h4>Parameters</h4>
+<a name="id-1.5.25.8.3.5"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -261,7 +261,7 @@ nm_ip_config_get_gateway (<em class="parameter"><code><a class="link" href="NMIP
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.5.21.8.3.6"></a><h4>Returns</h4>
+<a name="id-1.5.25.8.3.6"></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>
 </div>
@@ -273,7 +273,7 @@ nm_ip_config_get_gateway (<em class="parameter"><code><a class="link" href="NMIP
 nm_ip_config_get_addresses (<em class="parameter"><code><a class="link" href="NMIPConfig.html" title="NMIPConfig"><span class="type">NMIPConfig</span></a> *config</code></em>);</pre>
 <p>Gets the IP addresses (containing the address, prefix, and gateway).</p>
 <div class="refsect3">
-<a name="id-1.5.21.8.4.5"></a><h4>Parameters</h4>
+<a name="id-1.5.25.8.4.5"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -288,10 +288,11 @@ nm_ip_config_get_addresses (<em class="parameter"><code><a class="link" href="NM
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.5.21.8.4.6"></a><h4>Returns</h4>
+<a name="id-1.5.25.8.4.6"></a><h4>Returns</h4>
 <p> the <span class="type">GPtrArray</span>
 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. </p>
+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>
 </div>
 </div>
@@ -302,7 +303,7 @@ configuration and must not be modified. </p>
 nm_ip_config_get_routes (<em class="parameter"><code><a class="link" href="NMIPConfig.html" title="NMIPConfig"><span class="type">NMIPConfig</span></a> *config</code></em>);</pre>
 <p>Gets the routes.</p>
 <div class="refsect3">
-<a name="id-1.5.21.8.5.5"></a><h4>Parameters</h4>
+<a name="id-1.5.25.8.5.5"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -317,10 +318,11 @@ nm_ip_config_get_routes (<em class="parameter"><code><a class="link" href="NMIPC
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.5.21.8.5.6"></a><h4>Returns</h4>
+<a name="id-1.5.25.8.5.6"></a><h4>Returns</h4>
 <p> the <span class="type">GPtrArray</span> containing
 <a href="NMSettingIPConfig.html#NMIPRoute"><span class="type">NMIPRoutes</span></a>. This is the internal copy used by the configuration, and must
-not be modified. </p>
+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>
 </div>
 </div>
@@ -331,7 +333,7 @@ not be modified. </p>
 nm_ip_config_get_nameservers (<em class="parameter"><code><a class="link" href="NMIPConfig.html" title="NMIPConfig"><span class="type">NMIPConfig</span></a> *config</code></em>);</pre>
 <p>Gets the domain name servers (DNS).</p>
 <div class="refsect3">
-<a name="id-1.5.21.8.6.5"></a><h4>Parameters</h4>
+<a name="id-1.5.25.8.6.5"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -346,7 +348,7 @@ nm_ip_config_get_nameservers (<em class="parameter"><code><a class="link" href="
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.5.21.8.6.6"></a><h4>Returns</h4>
+<a name="id-1.5.25.8.6.6"></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>
 </div>
@@ -358,7 +360,7 @@ nm_ip_config_get_nameservers (<em class="parameter"><code><a class="link" href="
 nm_ip_config_get_domains (<em class="parameter"><code><a class="link" href="NMIPConfig.html" title="NMIPConfig"><span class="type">NMIPConfig</span></a> *config</code></em>);</pre>
 <p>Gets the domain names.</p>
 <div class="refsect3">
-<a name="id-1.5.21.8.7.5"></a><h4>Parameters</h4>
+<a name="id-1.5.25.8.7.5"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -373,7 +375,7 @@ nm_ip_config_get_domains (<em class="parameter"><code><a class="link" href="NMIP
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.5.21.8.7.6"></a><h4>Returns</h4>
+<a name="id-1.5.25.8.7.6"></a><h4>Returns</h4>
 <p> the array of domains.
 (This is never <code class="literal">NULL</code>, 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>
@@ -386,7 +388,7 @@ nm_ip_config_get_domains (<em class="parameter"><code><a class="link" href="NMIP
 nm_ip_config_get_searches (<em class="parameter"><code><a class="link" href="NMIPConfig.html" title="NMIPConfig"><span class="type">NMIPConfig</span></a> *config</code></em>);</pre>
 <p>Gets the DNS searches.</p>
 <div class="refsect3">
-<a name="id-1.5.21.8.8.5"></a><h4>Parameters</h4>
+<a name="id-1.5.25.8.8.5"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -401,7 +403,7 @@ nm_ip_config_get_searches (<em class="parameter"><code><a class="link" href="NMI
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.5.21.8.8.6"></a><h4>Returns</h4>
+<a name="id-1.5.25.8.8.6"></a><h4>Returns</h4>
 <p> the array of DNS search strings.
 (This is never <code class="literal">NULL</code>, 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>
@@ -414,7 +416,7 @@ nm_ip_config_get_searches (<em class="parameter"><code><a class="link" href="NMI
 nm_ip_config_get_wins_servers (<em class="parameter"><code><a class="link" href="NMIPConfig.html" title="NMIPConfig"><span class="type">NMIPConfig</span></a> *config</code></em>);</pre>
 <p>Gets the Windows Internet Name Service servers (WINS).</p>
 <div class="refsect3">
-<a name="id-1.5.21.8.9.5"></a><h4>Parameters</h4>
+<a name="id-1.5.25.8.9.5"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -429,7 +431,7 @@ nm_ip_config_get_wins_servers (<em class="parameter"><code><a class="link" href=
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.5.21.8.9.6"></a><h4>Returns</h4>
+<a name="id-1.5.25.8.9.6"></a><h4>Returns</h4>
 <p> the arry of WINS server IP address strings.
 (This is never <code class="literal">NULL</code>, 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>
generated by cgit-pink 1.3.0-6-gf8a5 (git 2.35.1) at 2026-08-27 14:22:50 +0000