diff options
| author | Sebastien Bacher <seb128@ubuntu.com> | 2021-01-11 17:41:24 +0100 |
|---|---|---|
| committer | Sebastien Bacher <seb128@ubuntu.com> | 2021-01-11 17:41:24 +0100 |
| commit | a82e048a943092315a32d745c99e0f5635e29134 (patch) | |
| tree | e2daea99a161768c9b956bfea9117289deaf31be /docs/libnm/html/NMDevice.html | |
| parent | b51f06ff71a2060925bf3c0f04c44bd12480e670 (diff) | |
| parent | 65f86e8f56267192d42f2b629fc6b0c99fb9cd0c (diff) | |
Merge branch 'upstream/latest' of https://salsa.debian.org/utopia-team/network-manager into upstream/latest
Diffstat (limited to 'docs/libnm/html/NMDevice.html')
| -rw-r--r-- | docs/libnm/html/NMDevice.html | 94 |
1 files changed, 47 insertions, 47 deletions
diff --git a/docs/libnm/html/NMDevice.html b/docs/libnm/html/NMDevice.html index 7a7cf8c5..358ca2fd 100644 --- a/docs/libnm/html/NMDevice.html +++ b/docs/libnm/html/NMDevice.html @@ -8,7 +8,7 @@ <link rel="up" href="ch04.html" title="Device and Runtime Configuration API Reference"> <link rel="prev" href="ch04.html" title="Device and Runtime Configuration API Reference"> <link rel="next" href="NMDevice6Lowpan.html" title="NMDevice6Lowpan"> -<meta name="generator" content="GTK-Doc V1.32 (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"> @@ -1178,7 +1178,7 @@ works with VPN connections.</p> <a name="nm-device-get-ip4-config.returns"></a><h4>Returns</h4> <p>the IPv4 <a class="link" href="NMIPConfig.html" title="NMIPConfig"><span class="type">NMIPConfig</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the device is not activated. </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> @@ -1208,7 +1208,7 @@ works with VPN connections.</p> <a name="nm-device-get-dhcp4-config.returns"></a><h4>Returns</h4> <p>the IPv4 <a class="link" href="NMDhcpConfig.html" title="NMDhcpConfig"><span class="type">NMDhcpConfig</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the device is not activated or not using DHCP. </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> @@ -1237,7 +1237,7 @@ works with VPN connections.</p> <div class="refsect3"> <a name="nm-device-get-ip6-config.returns"></a><h4>Returns</h4> <p>the IPv6 <a class="link" href="NMIPConfig.html" title="NMIPConfig"><span class="type">NMIPConfig</span></a> or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the device is not activated. </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> @@ -1267,7 +1267,7 @@ works with VPN connections.</p> <a name="nm-device-get-dhcp6-config.returns"></a><h4>Returns</h4> <p>the IPv6 <a class="link" href="NMDhcpConfig.html" title="NMDhcpConfig"><span class="type">NMDhcpConfig</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the device is not activated or not using DHCPv6. </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> @@ -1384,7 +1384,7 @@ nm_device_get_active_connection (<em class="parameter"><code><a class="link" hre <a name="nm-device-get-active-connection.returns"></a><h4>Returns</h4> <p>the <a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="type">NMActiveConnection</span></a> or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the device is not part of an active connection. </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> @@ -1671,7 +1671,7 @@ nm_device_get_lldp_neighbors (<em class="parameter"><code><a class="link" href=" containing <a class="link" href="NMDevice.html#NMLldpNeighbor"><span class="type">NMLldpNeighbor</span></a>s. This is the internal copy used by the device 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> NMLldpNeighbor][<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> NMLldpNeighbor][<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> <p class="since">Since: 1.2</p> </div> @@ -1737,7 +1737,7 @@ devices in <em class="parameter"><code>devices</code></em> <div class="refsect3"> <a name="nm-device-disambiguate-names.returns"></a><h4>Returns</h4> <p>the device names. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></p> +<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></p> </div> </div> <hr> @@ -1947,7 +1947,7 @@ nm_device_get_applied_connection (<em class="parameter"><code><a class="link" hr </tr> <tr> <td class="parameter_name"><p>flags</p></td> -<td class="parameter_description"><p>the flags argument. Currently this value must always be zero.</p></td> +<td class="parameter_description"><p>the flags argument. Currently, this value must always be zero.</p></td> <td class="parameter_annotations"> </td> </tr> <tr> @@ -1975,7 +1975,7 @@ the applied connection. </p></td> or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.</p> <p>The connection is as received from D-Bus and might not validate according to <a class="link" href="NMConnection.html#nm-connection-verify" title="nm_connection_verify ()"><code class="function">nm_connection_verify()</code></a>. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> </div> <p class="since">Since: 1.2</p> </div> @@ -2006,7 +2006,7 @@ nm_device_get_applied_connection_async </tr> <tr> <td class="parameter_name"><p>flags</p></td> -<td class="parameter_description"><p>the flags argument. Currently this value must always be zero.</p></td> +<td class="parameter_description"><p>the flags argument. Currently, this value must always be zero.</p></td> <td class="parameter_annotations"> </td> </tr> <tr> @@ -2079,7 +2079,7 @@ connection. </p></td> of error.</p> <p>The connection is as received from D-Bus and might not validate according to <a class="link" href="NMConnection.html#nm-connection-verify" title="nm_connection_verify ()"><code class="function">nm_connection_verify()</code></a>. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> </div> <p class="since">Since: 1.2</p> </div> @@ -2390,7 +2390,7 @@ incompatible with the device. To get the full list of connections see <a href="/usr/share/gtk-doc/html/libnm-util/NMConnection.html#NMConnection-struct"><span class="type">NMConnections</span></a> that could be activated with the given <em class="parameter"><code>device</code></em> . The array should be freed with <a href="https://developer.gnome.org/glib/unstable/glib-Pointer-Arrays.html#g-ptr-array-unref"><code class="function">g_ptr_array_unref()</code></a> when it is no longer required. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NMConnection]</span></p> +<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NMConnection]</span></p> </div> </div> <hr> @@ -2528,7 +2528,7 @@ nm_lldp_neighbor_new (<em class="parameter"><code><span class="type">void</span> <div class="refsect3"> <a name="nm-lldp-neighbor-new.returns"></a><h4>Returns</h4> <p>the new <a class="link" href="NMDevice.html#NMLldpNeighbor"><span class="type">NMLldpNeighbor</span></a> object. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> </div> <p class="since">Since: 1.2</p> </div> @@ -2604,7 +2604,7 @@ nm_lldp_neighbor_get_attr_names (<em class="parameter"><code><a class="link" hre <div class="refsect3"> <a name="nm-lldp-neighbor-get-attr-names.returns"></a><h4>Returns</h4> <p>a <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of attribute names. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> </div> <p class="since">Since: 1.2</p> </div> @@ -2641,7 +2641,7 @@ nm_lldp_neighbor_get_attr_string_value <tr> <td class="parameter_name"><p>out_value</p></td> <td class="parameter_description"><p>on return, the attribute value. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></td> </tr> </tbody> </table></div> @@ -2769,7 +2769,7 @@ nm_lldp_neighbor_get_attr_value (<em class="parameter"><code><a class="link" hre <p>the value or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the attribute with <em class="parameter"><code>name</code></em> was not found. </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> <p class="since">Since: 1.18</p> </div> @@ -2778,43 +2778,43 @@ not found. </p> <a name="NMDevice.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> <a name="NM-DEVICE-DEVICE-TYPE:CAPS"></a><h3>NM_DEVICE_DEVICE_TYPE</h3> -<pre class="programlisting">#define NM_DEVICE_DEVICE_TYPE "device-type" +<pre class="programlisting">#define NM_DEVICE_DEVICE_TYPE "device-type" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-UDI:CAPS"></a><h3>NM_DEVICE_UDI</h3> -<pre class="programlisting">#define NM_DEVICE_UDI "udi" +<pre class="programlisting">#define NM_DEVICE_UDI "udi" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-PATH:CAPS"></a><h3>NM_DEVICE_PATH</h3> -<pre class="programlisting">#define NM_DEVICE_PATH "path" +<pre class="programlisting">#define NM_DEVICE_PATH "path" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-INTERFACE:CAPS"></a><h3>NM_DEVICE_INTERFACE</h3> -<pre class="programlisting">#define NM_DEVICE_INTERFACE "interface" +<pre class="programlisting">#define NM_DEVICE_INTERFACE "interface" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-IP-INTERFACE:CAPS"></a><h3>NM_DEVICE_IP_INTERFACE</h3> -<pre class="programlisting">#define NM_DEVICE_IP_INTERFACE "ip-interface" +<pre class="programlisting">#define NM_DEVICE_IP_INTERFACE "ip-interface" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-DRIVER:CAPS"></a><h3>NM_DEVICE_DRIVER</h3> -<pre class="programlisting">#define NM_DEVICE_DRIVER "driver" +<pre class="programlisting">#define NM_DEVICE_DRIVER "driver" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-DRIVER-VERSION:CAPS"></a><h3>NM_DEVICE_DRIVER_VERSION</h3> -<pre class="programlisting">#define NM_DEVICE_DRIVER_VERSION "driver-version" +<pre class="programlisting">#define NM_DEVICE_DRIVER_VERSION "driver-version" </pre> </div> <hr> @@ -2826,19 +2826,19 @@ not found. </p> <hr> <div class="refsect2"> <a name="NM-DEVICE-CAPABILITIES:CAPS"></a><h3>NM_DEVICE_CAPABILITIES</h3> -<pre class="programlisting">#define NM_DEVICE_CAPABILITIES "capabilities" +<pre class="programlisting">#define NM_DEVICE_CAPABILITIES "capabilities" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-REAL:CAPS"></a><h3>NM_DEVICE_REAL</h3> -<pre class="programlisting">#define NM_DEVICE_REAL "real" +<pre class="programlisting">#define NM_DEVICE_REAL "real" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-MANAGED:CAPS"></a><h3>NM_DEVICE_MANAGED</h3> -<pre class="programlisting">#define NM_DEVICE_MANAGED "managed" +<pre class="programlisting">#define NM_DEVICE_MANAGED "managed" </pre> </div> <hr> @@ -2851,55 +2851,55 @@ not found. </p> <hr> <div class="refsect2"> <a name="NM-DEVICE-FIRMWARE-MISSING:CAPS"></a><h3>NM_DEVICE_FIRMWARE_MISSING</h3> -<pre class="programlisting">#define NM_DEVICE_FIRMWARE_MISSING "firmware-missing" +<pre class="programlisting">#define NM_DEVICE_FIRMWARE_MISSING "firmware-missing" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-NM-PLUGIN-MISSING:CAPS"></a><h3>NM_DEVICE_NM_PLUGIN_MISSING</h3> -<pre class="programlisting">#define NM_DEVICE_NM_PLUGIN_MISSING "nm-plugin-missing" +<pre class="programlisting">#define NM_DEVICE_NM_PLUGIN_MISSING "nm-plugin-missing" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-IP4-CONFIG:CAPS"></a><h3>NM_DEVICE_IP4_CONFIG</h3> -<pre class="programlisting">#define NM_DEVICE_IP4_CONFIG "ip4-config" +<pre class="programlisting">#define NM_DEVICE_IP4_CONFIG "ip4-config" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-DHCP4-CONFIG:CAPS"></a><h3>NM_DEVICE_DHCP4_CONFIG</h3> -<pre class="programlisting">#define NM_DEVICE_DHCP4_CONFIG "dhcp4-config" +<pre class="programlisting">#define NM_DEVICE_DHCP4_CONFIG "dhcp4-config" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-IP6-CONFIG:CAPS"></a><h3>NM_DEVICE_IP6_CONFIG</h3> -<pre class="programlisting">#define NM_DEVICE_IP6_CONFIG "ip6-config" +<pre class="programlisting">#define NM_DEVICE_IP6_CONFIG "ip6-config" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-DHCP6-CONFIG:CAPS"></a><h3>NM_DEVICE_DHCP6_CONFIG</h3> -<pre class="programlisting">#define NM_DEVICE_DHCP6_CONFIG "dhcp6-config" +<pre class="programlisting">#define NM_DEVICE_DHCP6_CONFIG "dhcp6-config" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-STATE:CAPS"></a><h3>NM_DEVICE_STATE</h3> -<pre class="programlisting">#define NM_DEVICE_STATE "state" +<pre class="programlisting">#define NM_DEVICE_STATE "state" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-STATE-REASON:CAPS"></a><h3>NM_DEVICE_STATE_REASON</h3> -<pre class="programlisting">#define NM_DEVICE_STATE_REASON "state-reason" +<pre class="programlisting">#define NM_DEVICE_STATE_REASON "state-reason" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-ACTIVE-CONNECTION:CAPS"></a><h3>NM_DEVICE_ACTIVE_CONNECTION</h3> -<pre class="programlisting">#define NM_DEVICE_ACTIVE_CONNECTION "active-connection" +<pre class="programlisting">#define NM_DEVICE_ACTIVE_CONNECTION "active-connection" </pre> </div> <hr> @@ -2911,66 +2911,66 @@ not found. </p> <hr> <div class="refsect2"> <a name="NM-DEVICE-VENDOR:CAPS"></a><h3>NM_DEVICE_VENDOR</h3> -<pre class="programlisting">#define NM_DEVICE_VENDOR "vendor" +<pre class="programlisting">#define NM_DEVICE_VENDOR "vendor" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-PRODUCT:CAPS"></a><h3>NM_DEVICE_PRODUCT</h3> -<pre class="programlisting">#define NM_DEVICE_PRODUCT "product" +<pre class="programlisting">#define NM_DEVICE_PRODUCT "product" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-PHYSICAL-PORT-ID:CAPS"></a><h3>NM_DEVICE_PHYSICAL_PORT_ID</h3> -<pre class="programlisting">#define NM_DEVICE_PHYSICAL_PORT_ID "physical-port-id" +<pre class="programlisting">#define NM_DEVICE_PHYSICAL_PORT_ID "physical-port-id" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-MTU:CAPS"></a><h3>NM_DEVICE_MTU</h3> -<pre class="programlisting">#define NM_DEVICE_MTU "mtu" +<pre class="programlisting">#define NM_DEVICE_MTU "mtu" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-METERED:CAPS"></a><h3>NM_DEVICE_METERED</h3> -<pre class="programlisting">#define NM_DEVICE_METERED "metered" +<pre class="programlisting">#define NM_DEVICE_METERED "metered" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-LLDP-NEIGHBORS:CAPS"></a><h3>NM_DEVICE_LLDP_NEIGHBORS</h3> -<pre class="programlisting">#define NM_DEVICE_LLDP_NEIGHBORS "lldp-neighbors" +<pre class="programlisting">#define NM_DEVICE_LLDP_NEIGHBORS "lldp-neighbors" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-IP4-CONNECTIVITY:CAPS"></a><h3>NM_DEVICE_IP4_CONNECTIVITY</h3> -<pre class="programlisting">#define NM_DEVICE_IP4_CONNECTIVITY "ip4-connectivity" +<pre class="programlisting">#define NM_DEVICE_IP4_CONNECTIVITY "ip4-connectivity" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-IP6-CONNECTIVITY:CAPS"></a><h3>NM_DEVICE_IP6_CONNECTIVITY</h3> -<pre class="programlisting">#define NM_DEVICE_IP6_CONNECTIVITY "ip6-connectivity" +<pre class="programlisting">#define NM_DEVICE_IP6_CONNECTIVITY "ip6-connectivity" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-INTERFACE-FLAGS:CAPS"></a><h3>NM_DEVICE_INTERFACE_FLAGS</h3> -<pre class="programlisting">#define NM_DEVICE_INTERFACE_FLAGS "interface-flags" +<pre class="programlisting">#define NM_DEVICE_INTERFACE_FLAGS "interface-flags" </pre> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-HW-ADDRESS:CAPS"></a><h3>NM_DEVICE_HW_ADDRESS</h3> -<pre class="programlisting">#define NM_DEVICE_HW_ADDRESS "hw-address" +<pre class="programlisting">#define NM_DEVICE_HW_ADDRESS "hw-address" </pre> </div> </div> </div> <div class="footer"> -<hr>Generated by GTK-Doc V1.32</div> +<hr>Generated by GTK-Doc V1.33.1</div> </body> </html> \ No newline at end of file |