summaryrefslogtreecommitdiff
path: root/docs/libnm-glib/html/NMActiveConnection.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libnm-glib/html/NMActiveConnection.html')
-rw-r--r--docs/libnm-glib/html/NMActiveConnection.html114
1 files changed, 35 insertions, 79 deletions
diff --git a/docs/libnm-glib/html/NMActiveConnection.html b/docs/libnm-glib/html/NMActiveConnection.html
index d5f1b381f..51037dca3 100644
--- a/docs/libnm-glib/html/NMActiveConnection.html
+++ b/docs/libnm-glib/html/NMActiveConnection.html
@@ -2,13 +2,13 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>libnm-glib Reference Manual: NMActiveConnection</title>
+<title>NMActiveConnection: libnm-glib Reference Manual</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="NMClient.html" title="NMClient">
<link rel="next" href="NMDevice.html" title="NMDevice">
-<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
+<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -344,8 +344,6 @@
</div>
<div class="refsect1">
<a name="NMActiveConnection.description"></a><h2>Description</h2>
-<p>
-</p>
</div>
<div class="refsect1">
<a name="NMActiveConnection.functions_details"></a><h2>Functions</h2>
@@ -411,7 +409,6 @@ nm_active_connection_get_connection (<em class="parameter"><code><a class="link"
<p> the object path of the <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> which this <a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="type">NMActiveConnection</span></a>
is an active instance of. This is the internal string used by the
connection, and must not be modified.</p>
-<p></p>
</div>
</div>
<hr>
@@ -439,9 +436,8 @@ nm_active_connection_get_id (<em class="parameter"><code><a class="link" href="N
<a name="id-1.3.3.8.4.6"></a><h4>Returns</h4>
<p> the ID of the <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> that backs the <a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="type">NMActiveConnection</span></a>.
This is the internal string used by the connection, and must not be modified.</p>
-<p></p>
</div>
-<p class="since">Since 0.9.10</p>
+<p class="since">Since: 0.9.10</p>
</div>
<hr>
<div class="refsect2">
@@ -468,7 +464,6 @@ nm_active_connection_get_uuid (<em class="parameter"><code><a class="link" href=
<a name="id-1.3.3.8.5.6"></a><h4>Returns</h4>
<p> the UUID of the <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> that backs the <a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="type">NMActiveConnection</span></a>.
This is the internal string used by the connection, and must not be modified.</p>
-<p></p>
</div>
</div>
<hr>
@@ -497,9 +492,8 @@ nm_active_connection_get_connection_type
<a name="id-1.3.3.8.6.6"></a><h4>Returns</h4>
<p> the type of the <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> that backs the <a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="type">NMActiveConnection</span></a>.
This is the internal string used by the connection, and must not be modified.</p>
-<p></p>
</div>
-<p class="since">Since 0.9.10</p>
+<p class="since">Since: 0.9.10</p>
</div>
<hr>
<div class="refsect2">
@@ -527,7 +521,6 @@ nm_active_connection_get_specific_object
<a name="id-1.3.3.8.7.6"></a><h4>Returns</h4>
<p> the specific object's DBus path. This is the internal string used by the
connection, and must not be modified.</p>
-<p></p>
</div>
</div>
<hr>
@@ -582,7 +575,6 @@ nm_active_connection_get_state (<em class="parameter"><code><a class="link" href
<div class="refsect3">
<a name="id-1.3.3.8.9.6"></a><h4>Returns</h4>
<p> the state</p>
-<p></p>
</div>
</div>
<hr>
@@ -610,7 +602,6 @@ nm_active_connection_get_master (<em class="parameter"><code><a class="link" hre
<a name="id-1.3.3.8.10.6"></a><h4>Returns</h4>
<p> the path of the master <a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</span></a> of the <a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="type">NMActiveConnection</span></a>.
This is the internal string used by the connection, and must not be modified.</p>
-<p></p>
</div>
</div>
<hr>
@@ -638,7 +629,6 @@ the default IPv4 route and DNS information).</p>
<div class="refsect3">
<a name="id-1.3.3.8.11.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the active connection is the default IPv4 connection</p>
-<p></p>
</div>
</div>
<hr>
@@ -665,11 +655,11 @@ nm_active_connection_get_ip4_config (<em class="parameter"><code><a class="link"
<div class="refsect3">
<a name="id-1.3.3.8.12.6"></a><h4>Returns</h4>
<p> the <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a>, or <code class="literal">NULL</code> if the
-connection is not in the <code class="literal">NM_ACTIVE_CONNECTION_STATE_ACTIVATED</code>
+connection is not in the <a href="https://developer.gnome.org/libnm-util/0.9/libnm-util-NetworkManager.html#NM-ACTIVE-CONNECTION-STATE-ACTIVATED:CAPS"><code class="literal">NM_ACTIVE_CONNECTION_STATE_ACTIVATED</code></a>
state. </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>
-<p class="since">Since 0.9.10</p>
+<p class="since">Since: 0.9.10</p>
</div>
<hr>
<div class="refsect2">
@@ -697,10 +687,10 @@ nm_active_connection_get_dhcp4_config (<em class="parameter"><code><a class="lin
<a name="id-1.3.3.8.13.6"></a><h4>Returns</h4>
<p> the <a class="link" href="NMDHCP4Config.html" title="NMDHCP4Config"><span class="type">NMDHCP4Config</span></a>, or <code class="literal">NULL</code> if the
connection does not use DHCP, or is not in the
-<code class="literal">NM_ACTIVE_CONNECTION_STATE_ACTIVATED</code> state. </p>
+<a href="https://developer.gnome.org/libnm-util/0.9/libnm-util-NetworkManager.html#NM-ACTIVE-CONNECTION-STATE-ACTIVATED:CAPS"><code class="literal">NM_ACTIVE_CONNECTION_STATE_ACTIVATED</code></a> state. </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>
-<p class="since">Since 0.9.10</p>
+<p class="since">Since: 0.9.10</p>
</div>
<hr>
<div class="refsect2">
@@ -727,7 +717,6 @@ the default IPv6 route and DNS information).</p>
<div class="refsect3">
<a name="id-1.3.3.8.14.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the active connection is the default IPv6 connection</p>
-<p></p>
</div>
</div>
<hr>
@@ -754,11 +743,11 @@ nm_active_connection_get_ip6_config (<em class="parameter"><code><a class="link"
<div class="refsect3">
<a name="id-1.3.3.8.15.6"></a><h4>Returns</h4>
<p> the <a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a>, or <code class="literal">NULL</code> if the
-connection is not in the <code class="literal">NM_ACTIVE_CONNECTION_STATE_ACTIVATED</code>
+connection is not in the <a href="https://developer.gnome.org/libnm-util/0.9/libnm-util-NetworkManager.html#NM-ACTIVE-CONNECTION-STATE-ACTIVATED:CAPS"><code class="literal">NM_ACTIVE_CONNECTION_STATE_ACTIVATED</code></a>
state. </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>
-<p class="since">Since 0.9.10</p>
+<p class="since">Since: 0.9.10</p>
</div>
<hr>
<div class="refsect2">
@@ -786,10 +775,10 @@ nm_active_connection_get_dhcp6_config (<em class="parameter"><code><a class="lin
<a name="id-1.3.3.8.16.6"></a><h4>Returns</h4>
<p> the <a class="link" href="NMDHCP6Config.html" title="NMDHCP6Config"><span class="type">NMDHCP6Config</span></a>, or <code class="literal">NULL</code> if the
connection does not use DHCPv6, or is not in the
-<code class="literal">NM_ACTIVE_CONNECTION_STATE_ACTIVATED</code> state. </p>
+<a href="https://developer.gnome.org/libnm-util/0.9/libnm-util-NetworkManager.html#NM-ACTIVE-CONNECTION-STATE-ACTIVATED:CAPS"><code class="literal">NM_ACTIVE_CONNECTION_STATE_ACTIVATED</code></a> state. </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>
-<p class="since">Since 0.9.10</p>
+<p class="since">Since: 0.9.10</p>
</div>
<hr>
<div class="refsect2">
@@ -815,9 +804,8 @@ nm_active_connection_get_vpn (<em class="parameter"><code><a class="link" href="
<div class="refsect3">
<a name="id-1.3.3.8.17.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the active connection is a VPN connection</p>
-<p></p>
</div>
-<p class="since">Since 0.9.10</p>
+<p class="since">Since: 0.9.10</p>
</div>
</div>
<div class="refsect1">
@@ -826,120 +814,90 @@ nm_active_connection_get_vpn (<em class="parameter"><code><a class="link" href="
<a name="NM-ACTIVE-CONNECTION-CONNECTION:CAPS"></a><h3>NM_ACTIVE_CONNECTION_CONNECTION</h3>
<pre class="programlisting">#define NM_ACTIVE_CONNECTION_CONNECTION "connection"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-ACTIVE-CONNECTION-ID:CAPS"></a><h3>NM_ACTIVE_CONNECTION_ID</h3>
<pre class="programlisting">#define NM_ACTIVE_CONNECTION_ID "id"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-ACTIVE-CONNECTION-UUID:CAPS"></a><h3>NM_ACTIVE_CONNECTION_UUID</h3>
<pre class="programlisting">#define NM_ACTIVE_CONNECTION_UUID "uuid"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-ACTIVE-CONNECTION-TYPE:CAPS"></a><h3>NM_ACTIVE_CONNECTION_TYPE</h3>
<pre class="programlisting">#define NM_ACTIVE_CONNECTION_TYPE "type"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-ACTIVE-CONNECTION-SPECIFIC-OBJECT:CAPS"></a><h3>NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT</h3>
<pre class="programlisting">#define NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT "specific-object"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-ACTIVE-CONNECTION-DEVICES:CAPS"></a><h3>NM_ACTIVE_CONNECTION_DEVICES</h3>
<pre class="programlisting">#define NM_ACTIVE_CONNECTION_DEVICES "devices"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-ACTIVE-CONNECTION-STATE:CAPS"></a><h3>NM_ACTIVE_CONNECTION_STATE</h3>
<pre class="programlisting">#define NM_ACTIVE_CONNECTION_STATE "state"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-ACTIVE-CONNECTION-DEFAULT:CAPS"></a><h3>NM_ACTIVE_CONNECTION_DEFAULT</h3>
<pre class="programlisting">#define NM_ACTIVE_CONNECTION_DEFAULT "default"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-ACTIVE-CONNECTION-IP4-CONFIG:CAPS"></a><h3>NM_ACTIVE_CONNECTION_IP4_CONFIG</h3>
<pre class="programlisting">#define NM_ACTIVE_CONNECTION_IP4_CONFIG "ip4-config"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-ACTIVE-CONNECTION-DHCP4-CONFIG:CAPS"></a><h3>NM_ACTIVE_CONNECTION_DHCP4_CONFIG</h3>
<pre class="programlisting">#define NM_ACTIVE_CONNECTION_DHCP4_CONFIG "dhcp4-config"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-ACTIVE-CONNECTION-DEFAULT6:CAPS"></a><h3>NM_ACTIVE_CONNECTION_DEFAULT6</h3>
<pre class="programlisting">#define NM_ACTIVE_CONNECTION_DEFAULT6 "default6"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-ACTIVE-CONNECTION-IP6-CONFIG:CAPS"></a><h3>NM_ACTIVE_CONNECTION_IP6_CONFIG</h3>
<pre class="programlisting">#define NM_ACTIVE_CONNECTION_IP6_CONFIG "ip6-config"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-ACTIVE-CONNECTION-DHCP6-CONFIG:CAPS"></a><h3>NM_ACTIVE_CONNECTION_DHCP6_CONFIG</h3>
<pre class="programlisting">#define NM_ACTIVE_CONNECTION_DHCP6_CONFIG "dhcp6-config"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-ACTIVE-CONNECTION-VPN:CAPS"></a><h3>NM_ACTIVE_CONNECTION_VPN</h3>
<pre class="programlisting">#define NM_ACTIVE_CONNECTION_VPN "vpn"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-ACTIVE-CONNECTION-MASTER:CAPS"></a><h3>NM_ACTIVE_CONNECTION_MASTER</h3>
<pre class="programlisting">#define NM_ACTIVE_CONNECTION_MASTER "master"
</pre>
-<p>
-</p>
</div>
</div>
<div class="refsect1">
@@ -947,7 +905,7 @@ nm_active_connection_get_vpn (<em class="parameter"><code><a class="link" href="
<div class="refsect2">
<a name="NMActiveConnection--connection"></a><h3>The <code class="literal">“connection”</code> property</h3>
<pre class="programlisting"> “connection” <span class="type">gchar</span> *</pre>
-<p></p>
+<p>The connection's path of the active connection.</p>
<p>Flags: Read</p>
<p>Default value: NULL</p>
</div>
@@ -955,7 +913,7 @@ nm_active_connection_get_vpn (<em class="parameter"><code><a class="link" href="
<div class="refsect2">
<a name="NMActiveConnection--default"></a><h3>The <code class="literal">“default”</code> property</h3>
<pre class="programlisting"> “default” <span class="type">gboolean</span></pre>
-<p></p>
+<p>Whether the active connection is the default IPv4 one.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
</div>
@@ -963,7 +921,7 @@ nm_active_connection_get_vpn (<em class="parameter"><code><a class="link" href="
<div class="refsect2">
<a name="NMActiveConnection--default6"></a><h3>The <code class="literal">“default6”</code> property</h3>
<pre class="programlisting"> “default6” <span class="type">gboolean</span></pre>
-<p></p>
+<p>Whether the active connection is the default IPv6 one.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
</div>
@@ -971,55 +929,54 @@ nm_active_connection_get_vpn (<em class="parameter"><code><a class="link" href="
<div class="refsect2">
<a name="NMActiveConnection--devices"></a><h3>The <code class="literal">“devices”</code> property</h3>
<pre class="programlisting"> “devices” <span class="type">NMObjectArray</span> *</pre>
-<p></p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="NMActiveConnection--dhcp4-config"></a><h3>The <code class="literal">“dhcp4-config”</code> property</h3>
<pre class="programlisting"> “dhcp4-config” <a class="link" href="NMDHCP4Config.html" title="NMDHCP4Config"><span class="type">NMDHCP4Config</span></a> *</pre>
-<p></p>
+<p>The <a class="link" href="NMDHCP4Config.html" title="NMDHCP4Config"><span class="type">NMDHCP4Config</span></a> of the connection.</p>
<p>Flags: Read</p>
-<p class="since">Since 0.9.10</p>
+<p class="since">Since: 0.9.10</p>
</div>
<hr>
<div class="refsect2">
<a name="NMActiveConnection--dhcp6-config"></a><h3>The <code class="literal">“dhcp6-config”</code> property</h3>
<pre class="programlisting"> “dhcp6-config” <a class="link" href="NMDHCP6Config.html" title="NMDHCP6Config"><span class="type">NMDHCP6Config</span></a> *</pre>
-<p></p>
+<p>The <a class="link" href="NMDHCP6Config.html" title="NMDHCP6Config"><span class="type">NMDHCP6Config</span></a> of the connection.</p>
<p>Flags: Read</p>
-<p class="since">Since 0.9.10</p>
+<p class="since">Since: 0.9.10</p>
</div>
<hr>
<div class="refsect2">
<a name="NMActiveConnection--id"></a><h3>The <code class="literal">“id”</code> property</h3>
<pre class="programlisting"> “id” <span class="type">gchar</span> *</pre>
-<p></p>
+<p>The active connection's ID</p>
<p>Flags: Read</p>
<p>Default value: NULL</p>
-<p class="since">Since 0.9.10</p>
+<p class="since">Since: 0.9.10</p>
</div>
<hr>
<div class="refsect2">
<a name="NMActiveConnection--ip4-config"></a><h3>The <code class="literal">“ip4-config”</code> property</h3>
<pre class="programlisting"> “ip4-config” <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> *</pre>
-<p></p>
+<p>The <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> of the connection.</p>
<p>Flags: Read</p>
-<p class="since">Since 0.9.10</p>
+<p class="since">Since: 0.9.10</p>
</div>
<hr>
<div class="refsect2">
<a name="NMActiveConnection--ip6-config"></a><h3>The <code class="literal">“ip6-config”</code> property</h3>
<pre class="programlisting"> “ip6-config” <a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> *</pre>
-<p></p>
+<p>The <a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> of the connection.</p>
<p>Flags: Read</p>
-<p class="since">Since 0.9.10</p>
+<p class="since">Since: 0.9.10</p>
</div>
<hr>
<div class="refsect2">
<a name="NMActiveConnection--master"></a><h3>The <code class="literal">“master”</code> property</h3>
<pre class="programlisting"> “master” <span class="type">gchar</span> *</pre>
-<p></p>
+<p>The path of the master device if one exists.</p>
<p>Flags: Read</p>
<p>Default value: NULL</p>
</div>
@@ -1027,7 +984,7 @@ nm_active_connection_get_vpn (<em class="parameter"><code><a class="link" href="
<div class="refsect2">
<a name="NMActiveConnection--specific-object"></a><h3>The <code class="literal">“specific-object”</code> property</h3>
<pre class="programlisting"> “specific-object” <span class="type">gchar</span> *</pre>
-<p></p>
+<p>The specific object's path of the active connection.</p>
<p>Flags: Read</p>
<p>Default value: NULL</p>
</div>
@@ -1035,7 +992,7 @@ nm_active_connection_get_vpn (<em class="parameter"><code><a class="link" href="
<div class="refsect2">
<a name="NMActiveConnection--state"></a><h3>The <code class="literal">“state”</code> property</h3>
<pre class="programlisting"> “state” <span class="type">guint</span></pre>
-<p></p>
+<p>The state of the active connection.</p>
<p>Flags: Read</p>
<p>Allowed values: &lt;= 3</p>
<p>Default value: 0</p>
@@ -1044,16 +1001,16 @@ nm_active_connection_get_vpn (<em class="parameter"><code><a class="link" href="
<div class="refsect2">
<a name="NMActiveConnection--type"></a><h3>The <code class="literal">“type”</code> property</h3>
<pre class="programlisting"> “type” <span class="type">gchar</span> *</pre>
-<p></p>
+<p>The active connection's type</p>
<p>Flags: Read</p>
<p>Default value: NULL</p>
-<p class="since">Since 0.9.10</p>
+<p class="since">Since: 0.9.10</p>
</div>
<hr>
<div class="refsect2">
<a name="NMActiveConnection--uuid"></a><h3>The <code class="literal">“uuid”</code> property</h3>
<pre class="programlisting"> “uuid” <span class="type">gchar</span> *</pre>
-<p></p>
+<p>The active connection's UUID</p>
<p>Flags: Read</p>
<p>Default value: NULL</p>
</div>
@@ -1061,15 +1018,14 @@ nm_active_connection_get_vpn (<em class="parameter"><code><a class="link" href="
<div class="refsect2">
<a name="NMActiveConnection--vpn"></a><h3>The <code class="literal">“vpn”</code> property</h3>
<pre class="programlisting"> “vpn” <span class="type">gboolean</span></pre>
-<p></p>
+<p>Whether the active connection is a VPN connection.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
-<p class="since">Since 0.9.10</p>
+<p class="since">Since: 0.9.10</p>
</div>
</div>
</div>
<div class="footer">
-<hr>
- Generated by GTK-Doc V1.21</div>
+<hr>Generated by GTK-Doc V1.24</div>
</body>
</html> \ No newline at end of file
generated by cgit v1.2.3 (git 2.39.1) at 2024-05-29 04:35:52 +0000