diff options
| author | Michael Biebl <biebl@debian.org> | 2015-07-14 19:38:58 +0200 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2015-07-14 19:38:58 +0200 |
| commit | 50a58f0fabd8a34c1b6108a107e08abe3c1ccd24 (patch) | |
| tree | 6790165f39daee79e2b6c6617483320613493367 /docs/libnm-util/html/libnm-util-nm-utils.html | |
| parent | f408e27bccfacf347605a8d98649975a68f38a17 (diff) | |
Imported Upstream version 1.0.4 upstream/1.0.4
Diffstat (limited to 'docs/libnm-util/html/libnm-util-nm-utils.html')
| -rw-r--r-- | docs/libnm-util/html/libnm-util-nm-utils.html | 92 |
1 files changed, 30 insertions, 62 deletions
diff --git a/docs/libnm-util/html/libnm-util-nm-utils.html b/docs/libnm-util/html/libnm-util-nm-utils.html index bdd5ddbd..9507d0ab 100644 --- a/docs/libnm-util/html/libnm-util-nm-utils.html +++ b/docs/libnm-util/html/libnm-util-nm-utils.html @@ -2,13 +2,13 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libnm-util Reference Manual: nm-utils</title> +<title>nm-utils: libnm-util Reference Manual</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="libnm-util Reference Manual"> <link rel="up" href="ch01.html" title="libnm-util API Reference"> <link rel="prev" href="NMSettingVPN.html" title="NMSettingVPN"> <link rel="next" href="libnm-util-NetworkManager.html" title="NetworkManager"> -<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"> @@ -520,7 +520,6 @@ uses libnm-util. This function can be called more than once.</p> <div class="refsect3"> <a name="id-1.2.30.8.2.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the initialization was successful, <code class="literal">FALSE</code> on failure.</p> -<p></p> </div> </div> <hr> @@ -566,7 +565,6 @@ number of known SSID-cloaking methods.</p> <div class="refsect3"> <a name="id-1.2.30.8.4.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the SSID is "empty", <code class="literal">FALSE</code> if it is not</p> -<p></p> </div> </div> <hr> @@ -606,7 +604,6 @@ be used for display of SSIDs.</p> <a name="id-1.2.30.8.5.6"></a><h4>Returns</h4> <p> pointer to the escaped SSID, which uses an internal static buffer and will be overwritten by subsequent calls to this function</p> -<p></p> </div> </div> <hr> @@ -652,7 +649,6 @@ NULLs, even though that is functionally pointless.</p> <div class="refsect3"> <a name="id-1.2.30.8.6.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the SSIDs are the same, <code class="literal">FALSE</code> if they are not</p> -<p></p> </div> </div> <hr> @@ -741,8 +737,9 @@ nm_utils_slist_free (<em class="parameter"><code><span class="type">GSList</span <p>use <code class="function">g_slist_free_full()</code>.</p> </div> <p>Utility function to free a <span class="type">GSList</span>.</p> +<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> <div class="refsect3"> -<a name="id-1.2.30.8.9.6"></a><h4>Parameters</h4> +<a name="id-1.2.30.8.9.7"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -840,7 +837,6 @@ e.g. (<a class="link" href="libnm-util-NetworkManager.html#NM-802-11-AP-SEC-PAIR <p> <code class="literal">TRUE</code> if the device capabilities and AP capabilties intersect and are compatible with the desired <em class="parameter"><code>type</code></em> , <code class="literal">FALSE</code> if they are not</p> -<p></p> </div> </div> <hr> @@ -881,9 +877,8 @@ e.g. <a class="link" href="libnm-util-nm-utils.html#NMU-SEC-STATIC-WEP:CAPS"><sp <p> <code class="literal">TRUE</code> if the device capabilities are compatible with the desired <em class="parameter"><code>type</code></em> , <code class="literal">FALSE</code> if they are not.</p> -<p></p> </div> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> @@ -919,9 +914,8 @@ nm_utils_wep_key_valid (<em class="parameter"><code>const <span class="type">cha <a name="id-1.2.30.8.12.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if <em class="parameter"><code>key</code></em> is a WEP key, <code class="literal">FALSE</code> if not</p> -<p></p> </div> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> @@ -949,9 +943,8 @@ nm_utils_wpa_psk_valid (<em class="parameter"><code>const <span class="type">cha <a name="id-1.2.30.8.13.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if <em class="parameter"><code>psk</code></em> is a WPA PSK, <code class="literal">FALSE</code> if not</p> -<p></p> </div> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> @@ -1110,7 +1103,6 @@ nm_utils_ip4_netmask_to_prefix (<em class="parameter"><code><span class="type">g <div class="refsect3"> <a name="id-1.2.30.8.18.5"></a><h4>Returns</h4> <p> the CIDR prefix represented by the netmask</p> -<p></p> </div> </div> <hr> @@ -1136,7 +1128,6 @@ nm_utils_ip4_prefix_to_netmask (<em class="parameter"><code><span class="type">g <div class="refsect3"> <a name="id-1.2.30.8.19.5"></a><h4>Returns</h4> <p> the netmask represented by the prefix, in network byte order</p> -<p></p> </div> </div> <hr> @@ -1166,7 +1157,6 @@ falls in the predefined classes.</p> <div class="refsect3"> <a name="id-1.2.30.8.20.6"></a><h4>Returns</h4> <p> the default class prefix for the given IP</p> -<p></p> </div> </div> <hr> @@ -1311,8 +1301,9 @@ which should be unset by the caller (when no longer needed) with nm_utils_ip6_dns_from_gvalue (<em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);</pre> <p>Converts a <span class="type">GValue</span> containing a <span class="type">GPtrArray</span> of IP6 DNS, represented as <span class="type">GByteArrays</span> into a <span class="type">GSList</span> of <code class="literal"><span class="type">struct in6_addr</span></code>s.</p> +<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> <div class="refsect3"> -<a name="id-1.2.30.8.25.5"></a><h4>Parameters</h4> +<a name="id-1.2.30.8.25.6"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -1327,9 +1318,8 @@ nm_utils_ip6_dns_from_gvalue (<em class="parameter"><code>const <span class="typ </table></div> </div> <div class="refsect3"> -<a name="id-1.2.30.8.25.6"></a><h4>Returns</h4> +<a name="id-1.2.30.8.25.7"></a><h4>Returns</h4> <p> a <span class="type">GSList</span> of IP6 addresses.</p> -<p></p> </div> </div> <hr> @@ -1343,8 +1333,9 @@ in6_addr</span></code> structs into a <span class="type">GPtrArray</span> of <sp representing each server's IPv6 addresses in network byte order. The specific format of this serialization is not guaranteed to be stable and may be extended in the future.</p> +<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> <div class="refsect3"> -<a name="id-1.2.30.8.26.5"></a><h4>Parameters</h4> +<a name="id-1.2.30.8.26.6"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -1377,7 +1368,6 @@ nm_utils_uuid_generate (<em class="parameter"><code><span class="type">void</spa <a name="id-1.2.30.8.27.4"></a><h4>Returns</h4> <p> a newly allocated UUID suitable for use as the <a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> object's <a class="link" href="NMSettingConnection.html#NMSettingConnection--id" title="The “id” property"><span class="type">“id”</span></a>: property. Should be freed with <code class="function">g_free()</code></p> -<p></p> </div> </div> <hr> @@ -1406,7 +1396,6 @@ nm_utils_uuid_generate_from_string (<em class="parameter"><code>const <span clas <a name="id-1.2.30.8.28.6"></a><h4>Returns</h4> <p> a newly allocated UUID suitable for use as the <a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> object's <a class="link" href="NMSettingConnection.html#NMSettingConnection--id" title="The “id” property"><span class="type">“id”</span></a>: property</p> -<p></p> </div> </div> <hr> @@ -1538,7 +1527,6 @@ nm_utils_file_is_pkcs12 (<em class="parameter"><code>const <span class="type">ch <div class="refsect3"> <a name="id-1.2.30.8.31.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the file is PKCS#12, <code class="literal">FALSE</code> if it is not</p> -<p></p> </div> </div> <hr> @@ -1547,12 +1535,6 @@ nm_utils_file_is_pkcs12 (<em class="parameter"><code>const <span class="type">ch <pre class="programlisting"><span class="returnvalue">gboolean</span> <span class="c_punctuation">(</span>*NMUtilsFileSearchInPathsPredicate<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>, <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p> -</p> -<div class="refsect3"> -<a name="id-1.2.30.8.32.5"></a><h4>Returns</h4> -<p></p> -</div> </div> <hr> <div class="refsect2"> @@ -1659,7 +1641,6 @@ nm_utils_wifi_freq_to_channel (<em class="parameter"><code><span class="type">gu <div class="refsect3"> <a name="id-1.2.30.8.34.6"></a><h4>Returns</h4> <p> the channel represented by the frequency or 0</p> -<p></p> </div> </div> <hr> @@ -1696,7 +1677,6 @@ nm_utils_wifi_channel_to_freq (<em class="parameter"><code><span class="type">gu <p> the frequency represented by the channel of the band, or -1 when the freq is invalid, or 0 when the band is invalid</p> -<p></p> </div> </div> <hr> @@ -1737,7 +1717,6 @@ nm_utils_wifi_find_next_channel (<em class="parameter"><code><span class="type"> <div class="refsect3"> <a name="id-1.2.30.8.36.6"></a><h4>Returns</h4> <p> the next channel in the specified direction or 0</p> -<p></p> </div> </div> <hr> @@ -1772,7 +1751,6 @@ nm_utils_wifi_is_channel_valid (<em class="parameter"><code><span class="type">g <div class="refsect3"> <a name="id-1.2.30.8.37.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code></p> -<p></p> </div> </div> <hr> @@ -1801,7 +1779,6 @@ nm_utils_hwaddr_len (<em class="parameter"><code><span class="type">int</span> t <div class="refsect3"> <a name="id-1.2.30.8.38.6"></a><h4>Returns</h4> <p> the positive length, or -1 if the type is unknown/unsupported.</p> -<p></p> </div> </div> <hr> @@ -1840,7 +1817,6 @@ a length; but you can just use <a class="link" href="libnm-util-nm-utils.html#nm <p> the type, either <code class="literal">ARPHRD_ETHER</code> or <code class="literal">ARPHRD_INFINIBAND</code>. If the length is unexpected, return -1 (unsupported type/length).</p> -<p></p> </div> </div> <hr> @@ -1970,7 +1946,6 @@ instead of a type.</p> <p> <em class="parameter"><code>buffer</code></em> , or <code class="literal">NULL</code> if <em class="parameter"><code>asc</code></em> couldn't be parsed</p> -<p></p> </div> </div> <hr> @@ -2010,7 +1985,7 @@ nm_utils_hwaddr_ntoa_len (<em class="parameter"><code><span class="type">gconstp . </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</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"> @@ -2059,9 +2034,8 @@ the size of the buffer in bytes.</p></td> couldn't be parsed or would be shorter or longer than <em class="parameter"><code>length</code></em> .</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"> @@ -2090,9 +2064,8 @@ nm_utils_hwaddr_valid (<em class="parameter"><code>const <span class="type">char <p> <code class="literal">TRUE</code> if <em class="parameter"><code>asc</code></em> appears to be a valid hardware address of some type, <code class="literal">FALSE</code> if not.</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"> @@ -2140,7 +2113,7 @@ array</p></td> . </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</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"> @@ -2167,9 +2140,8 @@ nm_utils_hex2byte (<em class="parameter"><code>const <span class="type">char</sp <a name="id-1.2.30.8.47.6"></a><h4>Returns</h4> <p> a byte, or -1 if <em class="parameter"><code>hex</code></em> doesn't represent a hex byte</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"> @@ -2209,7 +2181,7 @@ string (it has to be even)</p></td> <p> a array of bytes, or <code class="literal">NULL</code> on error. </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</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"> @@ -2236,9 +2208,8 @@ function in net/core/dev.c.</p> <div class="refsect3"> <a name="id-1.2.30.8.49.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if interface name is valid, otherwise <code class="literal">FALSE</code> is returned.</p> -<p></p> </div> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> @@ -2266,9 +2237,8 @@ nm_utils_is_uuid (<em class="parameter"><code>const <span class="type">char</spa <a name="id-1.2.30.8.50.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if <em class="parameter"><code>str</code></em> is a UUID, <code class="literal">FALSE</code> if not</p> -<p></p> </div> -<p class="since">Since 0.9.8</p> +<p class="since">Since: 0.9.8</p> </div> <hr> <div class="refsect2"> @@ -2277,8 +2247,9 @@ is a UUID, <code class="literal">FALSE</code> if not</p> nm_utils_inet4_ntop (<em class="parameter"><code><span class="type">in_addr_t</span> inaddr</code></em>, <em class="parameter"><code><span class="type">char</span> *dst</code></em>);</pre> <p>Wrapper for inet_ntop.</p> +<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> <div class="refsect3"> -<a name="id-1.2.30.8.51.5"></a><h4>Parameters</h4> +<a name="id-1.2.30.8.51.6"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -2309,13 +2280,12 @@ buffer to avoid these issues.</p></td> </table></div> </div> <div class="refsect3"> -<a name="id-1.2.30.8.51.6"></a><h4>Returns</h4> +<a name="id-1.2.30.8.51.7"></a><h4>Returns</h4> <p> the input buffer <em class="parameter"><code>dst</code></em> , or a pointer to an internal, static buffer. This function cannot fail.</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"> @@ -2324,8 +2294,9 @@ internal, static buffer. This function cannot fail.</p> nm_utils_inet6_ntop (<em class="parameter"><code>const <span class="type">struct in6_addr</span> *in6addr</code></em>, <em class="parameter"><code><span class="type">char</span> *dst</code></em>);</pre> <p>Wrapper for inet_ntop.</p> +<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> <div class="refsect3"> -<a name="id-1.2.30.8.52.5"></a><h4>Parameters</h4> +<a name="id-1.2.30.8.52.6"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -2356,15 +2327,14 @@ buffer to avoid these issues.</p></td> </table></div> </div> <div class="refsect3"> -<a name="id-1.2.30.8.52.6"></a><h4>Returns</h4> +<a name="id-1.2.30.8.52.7"></a><h4>Returns</h4> <p> the input buffer <em class="parameter"><code>dst</code></em> , or a pointer to an internal, static buffer. <code class="literal">NULL</code> is not allowed as <em class="parameter"><code>in6addr</code></em> , otherwise, this function cannot fail.</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"> @@ -2419,9 +2389,8 @@ underlying device driver.</p> <div class="refsect3"> <a name="id-1.2.30.8.53.9"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code></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"> @@ -2529,7 +2498,6 @@ for both <a class="link" href="libnm-util-nm-utils.html#nm-utils-inet4-ntop" tit </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 |