diff options
Diffstat (limited to 'docs/libnm/html/libnm-nm-utils.html')
| -rw-r--r-- | docs/libnm/html/libnm-nm-utils.html | 265 |
1 files changed, 208 insertions, 57 deletions
diff --git a/docs/libnm/html/libnm-nm-utils.html b/docs/libnm/html/libnm-nm-utils.html index 123ff21a..864e8463 100644 --- a/docs/libnm/html/libnm-nm-utils.html +++ b/docs/libnm/html/libnm-nm-utils.html @@ -296,6 +296,14 @@ </td> </tr> <tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="libnm-nm-utils.html#NMUtilsCheckFilePredicate" title="NMUtilsCheckFilePredicate ()">*NMUtilsCheckFilePredicate</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> <td class="function_type">const <span class="returnvalue">char</span> * </td> <td class="function_name"> @@ -475,6 +483,21 @@ </tr> <tr> <td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<a class="link" href="libnm-nm-utils.html#nm-utils-bond-mode-string-to-int" title="nm_utils_bond_mode_string_to_int ()">nm_utils_bond_mode_string_to_int</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="libnm-nm-utils.html#nm-utils-bond-mode-int-to-string" title="nm_utils_bond_mode_int_to_string ()">nm_utils_bond_mode_int_to_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> <span class="returnvalue">char</span> * </td> <td class="function_name"> @@ -489,6 +512,13 @@ <a class="link" href="libnm-nm-utils.html#nm-utils-enum-from-str" title="nm_utils_enum_from_str ()">nm_utils_enum_from_str</a> <span class="c_punctuation">()</span> </td> </tr> +<tr> +<td class="function_type">const <span class="returnvalue">char</span> ** +</td> +<td class="function_name"> +<a class="link" href="libnm-nm-utils.html#nm-utils-enum-get-values" title="nm_utils_enum_get_values ()">nm_utils_enum_get_values</a> <span class="c_punctuation">()</span> +</td> +</tr> </tbody> </table></div> </div> @@ -512,12 +542,16 @@ <td class="define_keyword">#define</td> <td class="function_name"><a class="link" href="libnm-nm-utils.html#NM-UTILS-INET-ADDRSTRLEN:CAPS" title="NM_UTILS_INET_ADDRSTRLEN">NM_UTILS_INET_ADDRSTRLEN</a></td> </tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="libnm-nm-utils.html#stat" title="struct stat">stat</a></td> +</tr> </tbody> </table></div> </div> <div class="refsect1"> <a name="libnm-nm-utils.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GEnum +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a> <span class="lineart">╰──</span> NMUtilsSecurityType </pre> </div> @@ -1633,6 +1667,15 @@ nm_utils_file_is_pkcs12 (<em class="parameter"><code>const <span class="type">ch </div> <hr> <div class="refsect2"> +<a name="NMUtilsCheckFilePredicate"></a><h3>NMUtilsCheckFilePredicate ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +<span class="c_punctuation">(</span>*NMUtilsCheckFilePredicate<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>, + <em class="parameter"><code>const <span class="type">struct stat</span> *stat</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>, + <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> +</div> +<hr> +<div class="refsect2"> <a name="nm-utils-file-search-in-paths"></a><h3>nm_utils_file_search_in_paths ()</h3> <pre class="programlisting">const <span class="returnvalue">char</span> * nm_utils_file_search_in_paths (<em class="parameter"><code>const <span class="type">char</span> *progname</code></em>, @@ -1646,7 +1689,7 @@ nm_utils_file_search_in_paths (<em class="parameter"><code>const <span class="ty file in a list of search <em class="parameter"><code>paths</code></em> .</p> <div class="refsect3"> -<a name="id-1.6.2.7.34.5"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.35.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -1705,7 +1748,7 @@ function. </p></td> </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.34.6"></a><h4>Returns</h4> +<a name="id-1.6.2.7.35.6"></a><h4>Returns</h4> <p> the full path to the helper, if found, or <code class="literal">NULL</code> if not found. The returned string is not owned by the caller, but later invocations of the function might overwrite it. </p> @@ -1719,7 +1762,7 @@ invocations of the function might overwrite it. </p> nm_utils_wifi_freq_to_channel (<em class="parameter"><code><span class="type">guint32</span> freq</code></em>);</pre> <p>Utility function to translate a Wi-Fi frequency to its corresponding channel.</p> <div class="refsect3"> -<a name="id-1.6.2.7.35.5"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.36.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -1734,7 +1777,7 @@ nm_utils_wifi_freq_to_channel (<em class="parameter"><code><span class="type">gu </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.35.6"></a><h4>Returns</h4> +<a name="id-1.6.2.7.36.6"></a><h4>Returns</h4> <p> the channel represented by the frequency or 0</p> </div> </div> @@ -1746,7 +1789,7 @@ nm_utils_wifi_channel_to_freq (<em class="parameter"><code><span class="type">gu <em class="parameter"><code>const <span class="type">char</span> *band</code></em>);</pre> <p>Utility function to translate a Wi-Fi channel to its corresponding frequency.</p> <div class="refsect3"> -<a name="id-1.6.2.7.36.5"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.37.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -1768,7 +1811,7 @@ nm_utils_wifi_channel_to_freq (<em class="parameter"><code><span class="type">gu </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.36.6"></a><h4>Returns</h4> +<a name="id-1.6.2.7.37.6"></a><h4>Returns</h4> <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> @@ -1783,7 +1826,7 @@ nm_utils_wifi_find_next_channel (<em class="parameter"><code><span class="type"> <em class="parameter"><code><span class="type">char</span> *band</code></em>);</pre> <p>Utility function to find out next/previous Wi-Fi channel for a channel.</p> <div class="refsect3"> -<a name="id-1.6.2.7.37.5"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.38.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -1810,7 +1853,7 @@ nm_utils_wifi_find_next_channel (<em class="parameter"><code><span class="type"> </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.37.6"></a><h4>Returns</h4> +<a name="id-1.6.2.7.38.6"></a><h4>Returns</h4> <p> the next channel in the specified direction or 0</p> </div> </div> @@ -1822,7 +1865,7 @@ nm_utils_wifi_is_channel_valid (<em class="parameter"><code><span class="type">g <em class="parameter"><code>const <span class="type">char</span> *band</code></em>);</pre> <p>Utility function to verify Wi-Fi channel validity.</p> <div class="refsect3"> -<a name="id-1.6.2.7.38.5"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.39.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -1844,7 +1887,7 @@ nm_utils_wifi_is_channel_valid (<em class="parameter"><code><span class="type">g </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.38.6"></a><h4>Returns</h4> +<a name="id-1.6.2.7.39.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code></p> </div> </div> @@ -1855,10 +1898,10 @@ nm_utils_wifi_is_channel_valid (<em class="parameter"><code><span class="type">g nm_utils_wifi_2ghz_freqs (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p>Utility function to return 2.4 GHz Wi-Fi frequencies (802.11bg band).</p> <div class="refsect3"> -<a name="id-1.6.2.7.39.5"></a><h4>Returns</h4> +<a name="id-1.6.2.7.40.5"></a><h4>Returns</h4> <p> zero-terminated array of frequencies numbers (in MHz)</p> </div> -<p class="since">Since: 1.0.6</p> +<p class="since">Since: 1.2</p> </div> <hr> <div class="refsect2"> @@ -1867,10 +1910,10 @@ nm_utils_wifi_2ghz_freqs (<em class="parameter"><code><span class="type">void</s nm_utils_wifi_5ghz_freqs (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p>Utility function to return 5 GHz Wi-Fi frequencies (802.11a band).</p> <div class="refsect3"> -<a name="id-1.6.2.7.40.5"></a><h4>Returns</h4> +<a name="id-1.6.2.7.41.5"></a><h4>Returns</h4> <p> zero-terminated array of frequencies numbers (in MHz)</p> </div> -<p class="since">Since: 1.0.6</p> +<p class="since">Since: 1.2</p> </div> <hr> <div class="refsect2"> @@ -1883,7 +1926,7 @@ strength suitable for printing to stdout. If the current locale and terminal support it, this will use unicode graphics characters to represent "bars". Otherwise it will use 0 to 4 asterisks.</p> <div class="refsect3"> -<a name="id-1.6.2.7.41.5"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.42.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -1898,7 +1941,7 @@ support it, this will use unicode graphics characters to represent </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.41.6"></a><h4>Returns</h4> +<a name="id-1.6.2.7.42.6"></a><h4>Returns</h4> <p> the graphical representation of the access point strength</p> </div> </div> @@ -1912,7 +1955,7 @@ nm_utils_hwaddr_len (<em class="parameter"><code><span class="type">int</span> t <p>It is an error to call this function with any value other than <code class="literal">ARPHRD_ETHER</code> or <code class="literal">ARPHRD_INFINIBAND</code>.</p> <div class="refsect3"> -<a name="id-1.6.2.7.42.6"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.43.6"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -1928,7 +1971,7 @@ nm_utils_hwaddr_len (<em class="parameter"><code><span class="type">int</span> t </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.42.7"></a><h4>Returns</h4> +<a name="id-1.6.2.7.43.7"></a><h4>Returns</h4> <p> the length.</p> </div> </div> @@ -1941,7 +1984,7 @@ nm_utils_hwaddr_ntoa (<em class="parameter"><code><span class="type">gconstpoint <p>Converts <em class="parameter"><code>addr</code></em> to textual form.</p> <div class="refsect3"> -<a name="id-1.6.2.7.43.5"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.44.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -1964,7 +2007,7 @@ nm_utils_hwaddr_ntoa (<em class="parameter"><code><span class="type">gconstpoint </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.43.6"></a><h4>Returns</h4> +<a name="id-1.6.2.7.44.6"></a><h4>Returns</h4> <p> the textual form of <em class="parameter"><code>addr</code></em> . </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> @@ -1980,7 +2023,7 @@ nm_utils_hwaddr_atoba (<em class="parameter"><code>const <span class="type">char and converts it to binary form in a <span class="type">GByteArray</span>. See <a class="link" href="libnm-nm-utils.html#nm-utils-hwaddr-aton" title="nm_utils_hwaddr_aton ()"><code class="function">nm_utils_hwaddr_aton()</code></a> if you don't want a <span class="type">GByteArray</span>.</p> <div class="refsect3"> -<a name="id-1.6.2.7.44.5"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.45.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -2002,7 +2045,7 @@ nm_utils_hwaddr_atoba (<em class="parameter"><code>const <span class="type">char </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.44.6"></a><h4>Returns</h4> +<a name="id-1.6.2.7.45.6"></a><h4>Returns</h4> <p> a new <span class="type">GByteArray</span>, or <code class="literal">NULL</code> if <em class="parameter"><code>asc</code></em> couldn't be parsed. </p> @@ -2022,7 +2065,7 @@ nm_utils_hwaddr_aton (<em class="parameter"><code>const <span class="type">char< Bytes in <em class="parameter"><code>asc</code></em> can be sepatared by colons (:), or hyphens (-), but not mixed.</p> <div class="refsect3"> -<a name="id-1.6.2.7.45.5"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.46.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -2050,7 +2093,7 @@ the size of the buffer in bytes.</p></td> </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.45.6"></a><h4>Returns</h4> +<a name="id-1.6.2.7.46.6"></a><h4>Returns</h4> <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 @@ -2068,7 +2111,7 @@ nm_utils_hwaddr_valid (<em class="parameter"><code>const <span class="type">char to see if it is a valid hardware address of the given length.</p> <div class="refsect3"> -<a name="id-1.6.2.7.46.5"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.47.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -2092,7 +2135,7 @@ is expected to convert to </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.46.6"></a><h4>Returns</h4> +<a name="id-1.6.2.7.47.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if <em class="parameter"><code>asc</code></em> appears to be a valid hardware address of the indicated length, <code class="literal">FALSE</code> if not.</p> @@ -2109,7 +2152,7 @@ nm_utils_hwaddr_canonical (<em class="parameter"><code>const <span class="type"> length, and if so, returns it in canonical form (uppercase, with leading 0s as needed, and with colons rather than hyphens).</p> <div class="refsect3"> -<a name="id-1.6.2.7.47.5"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.48.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -2133,7 +2176,7 @@ is expected to convert to </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.47.6"></a><h4>Returns</h4> +<a name="id-1.6.2.7.48.6"></a><h4>Returns</h4> <p> the canonicalized address if <em class="parameter"><code>asc</code></em> appears to be a valid hardware address of the indicated length, <code class="literal">NULL</code> if not. </p> @@ -2180,7 +2223,7 @@ match. (This means that externally-provided address strings do not need to be sanity-checked before comparing them against known good addresses; they are guaranteed to not match if they are invalid.)</p> <div class="refsect3"> -<a name="id-1.6.2.7.48.7"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.49.7"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -2216,7 +2259,7 @@ is ASCII</p></td> </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.48.8"></a><h4>Returns</h4> +<a name="id-1.6.2.7.49.8"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if <em class="parameter"><code>hwaddr1</code></em> and <em class="parameter"><code>hwaddr2</code></em> are equivalent, <code class="literal">FALSE</code> if they are @@ -2236,7 +2279,7 @@ nm_utils_bin2hexstr (<em class="parameter"><code><span class="type">gconstpointe greater than -1, the returned string is terminated at that index (returned_string[final_len] == '\0'),</p> <div class="refsect3"> -<a name="id-1.6.2.7.49.5"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.50.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -2264,7 +2307,7 @@ array</p></td> </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.49.6"></a><h4>Returns</h4> +<a name="id-1.6.2.7.50.6"></a><h4>Returns</h4> <p> the textual form of <em class="parameter"><code>bytes</code></em> . </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> @@ -2283,7 +2326,7 @@ eg "00:11" or "0:1". Any "0x" at the beginning of <em class="parameter"><code>h may not start or end with ':'.</p> <div class="refsect3"> -<a name="id-1.6.2.7.50.5"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.51.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -2298,7 +2341,7 @@ may not start or end with ':'.</p> </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.50.6"></a><h4>Returns</h4> +<a name="id-1.6.2.7.51.6"></a><h4>Returns</h4> <p> the converted 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> @@ -2311,7 +2354,7 @@ nm_utils_iface_valid_name (<em class="parameter"><code>const <span class="type"> <p>This function is a 1:1 copy of the kernel's interface validation function in net/core/dev.c.</p> <div class="refsect3"> -<a name="id-1.6.2.7.51.5"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.52.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -2326,7 +2369,7 @@ function in net/core/dev.c.</p> </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.51.6"></a><h4>Returns</h4> +<a name="id-1.6.2.7.52.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> </div> </div> @@ -2338,7 +2381,7 @@ nm_utils_is_uuid (<em class="parameter"><code>const <span class="type">char</spa <p>Checks if <em class="parameter"><code>str</code></em> is a UUID</p> <div class="refsect3"> -<a name="id-1.6.2.7.52.5"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.53.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -2353,7 +2396,7 @@ nm_utils_is_uuid (<em class="parameter"><code>const <span class="type">char</spa </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.52.6"></a><h4>Returns</h4> +<a name="id-1.6.2.7.53.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> </div> @@ -2367,7 +2410,7 @@ nm_utils_inet4_ntop (<em class="parameter"><code><span class="type">in_addr_t</s <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.6.2.7.53.6"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.54.6"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -2398,7 +2441,7 @@ buffer to avoid these issues.</p></td> </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.53.7"></a><h4>Returns</h4> +<a name="id-1.6.2.7.54.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> @@ -2413,7 +2456,7 @@ nm_utils_inet6_ntop (<em class="parameter"><code>const <span class="type">struct <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.6.2.7.54.6"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.55.6"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -2444,7 +2487,7 @@ buffer to avoid these issues.</p></td> </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.54.7"></a><h4>Returns</h4> +<a name="id-1.6.2.7.55.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> @@ -2461,7 +2504,7 @@ nm_utils_ipaddr_valid (<em class="parameter"><code><span class="type">int</span> <p>Checks if <em class="parameter"><code>ip</code></em> contains a valid IP address of the given family.</p> <div class="refsect3"> -<a name="id-1.6.2.7.55.5"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.56.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -2484,7 +2527,7 @@ nm_utils_ipaddr_valid (<em class="parameter"><code><span class="type">int</span> </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.55.6"></a><h4>Returns</h4> +<a name="id-1.6.2.7.56.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code></p> </div> </div> @@ -2516,7 +2559,7 @@ compatible with <em class="parameter"><code>virtual_type</code></em> configuration of the two connections, or on the capabilities of an underlying device driver.</p> <div class="refsect3"> -<a name="id-1.6.2.7.56.8"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.57.8"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -2539,12 +2582,72 @@ underlying device driver.</p> </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.56.9"></a><h4>Returns</h4> +<a name="id-1.6.2.7.57.9"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code></p> </div> </div> <hr> <div class="refsect2"> +<a name="nm-utils-bond-mode-string-to-int"></a><h3>nm_utils_bond_mode_string_to_int ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +nm_utils_bond_mode_string_to_int (<em class="parameter"><code>const <span class="type">char</span> *mode</code></em>);</pre> +<p>Convert bonding mode from string representation to numeric value. +See https://www.kernel.org/doc/Documentation/networking/bonding.txt for +available modes. +The <em class="parameter"><code>mode</code></em> + string can be either a descriptive name or a number (as string).</p> +<div class="refsect3"> +<a name="id-1.6.2.7.58.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>mode</p></td> +<td class="parameter_description"><p>bonding mode as string</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.6.2.7.58.6"></a><h4>Returns</h4> +<p> numeric bond mode, or -1 on error</p> +</div> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-utils-bond-mode-int-to-string"></a><h3>nm_utils_bond_mode_int_to_string ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +nm_utils_bond_mode_int_to_string (<em class="parameter"><code><span class="type">int</span> mode</code></em>);</pre> +<p>Convert bonding mode from integer value to descriptive name. +See https://www.kernel.org/doc/Documentation/networking/bonding.txt for +available modes.</p> +<div class="refsect3"> +<a name="id-1.6.2.7.59.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>mode</p></td> +<td class="parameter_description"><p>bonding mode as a numeric value</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.6.2.7.59.6"></a><h4>Returns</h4> +<p> bonding mode string, or NULL on error</p> +</div> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> <a name="nm-utils-enum-to-str"></a><h3>nm_utils_enum_to_str ()</h3> <pre class="programlisting"><span class="returnvalue">char</span> * nm_utils_enum_to_str (<em class="parameter"><code><span class="type">GType</span> type</code></em>, @@ -2554,7 +2657,7 @@ nm_utils_enum_to_str (<em class="parameter"><code><span class="type">GType</span If the enum is a <code class="literal">G_TYPE_ENUM</code> and the given value is not valid the function returns <code class="literal">NULL</code>.</p> <div class="refsect3"> -<a name="id-1.6.2.7.57.5"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.60.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -2576,10 +2679,10 @@ function returns <code class="literal">NULL</code>.</p> </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.57.6"></a><h4>Returns</h4> +<a name="id-1.6.2.7.60.6"></a><h4>Returns</h4> <p> a newly allocated string or <code class="literal">NULL</code></p> </div> -<p class="since">Since: 1.0.6</p> +<p class="since">Since: 1.2</p> </div> <hr> <div class="refsect2"> @@ -2596,7 +2699,7 @@ the function returns <code class="literal">FALSE</code> and stores a pointer to containing the unrecognized token in <em class="parameter"><code>err_token</code></em> .</p> <div class="refsect3"> -<a name="id-1.6.2.7.58.6"></a><h4>Parameters</h4> +<a name="id-1.6.2.7.61.6"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -2616,22 +2719,65 @@ containing the unrecognized token in <em class="parameter"><code>err_token</code </tr> <tr> <td class="parameter_name"><p>out_value</p></td> -<td class="parameter_description"><p>(out) (allow-none) the output value</p></td> -<td class="parameter_annotations"> </td> +<td class="parameter_description"><p> the output 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>]</span></td> </tr> <tr> <td class="parameter_name"><p>err_token</p></td> -<td class="parameter_description"><p>(out) (allow-none) location to store the first unrecognized token</p></td> -<td class="parameter_annotations"> </td> +<td class="parameter_description"><p> location to store the first unrecognized token. </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>]</span></td> </tr> </tbody> </table></div> </div> <div class="refsect3"> -<a name="id-1.6.2.7.58.7"></a><h4>Returns</h4> +<a name="id-1.6.2.7.61.7"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the conversion was successful, <code class="literal">FALSE</code> otherwise</p> </div> -<p class="since">Since: 1.0.6</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-utils-enum-get-values"></a><h3>nm_utils_enum_get_values ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> ** +nm_utils_enum_get_values (<em class="parameter"><code><span class="type">GType</span> type</code></em>, + <em class="parameter"><code><span class="type">gint</span> from</code></em>, + <em class="parameter"><code><span class="type">gint</span> to</code></em>);</pre> +<p>Returns the list of possible values for a given enum.</p> +<div class="refsect3"> +<a name="id-1.6.2.7.62.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>type</p></td> +<td class="parameter_description"><p>the <code class="literal">GType</code> of the enum</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>from</p></td> +<td class="parameter_description"><p>the first element to be returned</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>to</p></td> +<td class="parameter_description"><p>the last element to be returned</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.6.2.7.62.6"></a><h4>Returns</h4> +<p> a NULL-terminated dynamically-allocated array of static strings +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: 1.2</p> </div> </div> <div class="refsect1"> @@ -2736,6 +2882,11 @@ generating the dynamic WEP keys automatically</p> argument for both <a class="link" href="libnm-nm-utils.html#nm-utils-inet4-ntop" title="nm_utils_inet4_ntop ()"><code class="function">nm_utils_inet4_ntop()</code></a> and <a class="link" href="libnm-nm-utils.html#nm-utils-inet6-ntop" title="nm_utils_inet6_ntop ()"><code class="function">nm_utils_inet6_ntop()</code></a>.</p> </div> +<hr> +<div class="refsect2"> +<a name="stat"></a><h3>struct stat</h3> +<pre class="programlisting">struct stat;</pre> +</div> </div> </div> <div class="footer"> |