diff options
Diffstat (limited to 'docs/libnm-util/html/libnm-util-nm-utils.html')
| -rw-r--r-- | docs/libnm-util/html/libnm-util-nm-utils.html | 535 |
1 files changed, 420 insertions, 115 deletions
diff --git a/docs/libnm-util/html/libnm-util-nm-utils.html b/docs/libnm-util/html/libnm-util-nm-utils.html index f26503392..ccf9ab5e6 100644 --- a/docs/libnm-util/html/libnm-util-nm-utils.html +++ b/docs/libnm-util/html/libnm-util-nm-utils.html @@ -8,7 +8,7 @@ <link rel="up" href="ch01.html" title="libnm-util API Reference"> <link rel="prev" href="NMSettingVPN.html" title="NMSettingVPN"> <link rel="next" href="object-tree.html" title="Object Hierarchy"> -<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -26,7 +26,7 @@ <a href="#libnm-util-nm-utils.description" class="shortcut">Description</a> </td></tr> </table> -<div class="refentry"> +<div class="refentry" title="nm-utils"> <a name="libnm-util-nm-utils"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> @@ -35,11 +35,29 @@ </td> <td valign="top" align="right"></td> </tr></table></div> -<div class="refsynopsisdiv"> +<div class="refsynopsisdiv" title="Synopsis"> <a name="libnm-util-nm-utils.synopsis"></a><h2>Synopsis</h2> <pre class="synopsis"> #include <nm-utils.h> +#define <a class="link" href="libnm-util-nm-utils.html#nm-print-backtrace" title="nm_print_backtrace">nm_print_backtrace</a> +#define <a class="link" href="libnm-util-nm-utils.html#nm-get-timestamp" title="nm_get_timestamp()">nm_get_timestamp</a> (timestamp) +#define <a class="link" href="libnm-util-nm-utils.html#nm-info" title="nm_info()">nm_info</a> (fmt, + args...) +#define <a class="link" href="libnm-util-nm-utils.html#nm-info-str" title="nm_info_str()">nm_info_str</a> (fmt_str, + args...) +#define <a class="link" href="libnm-util-nm-utils.html#nm-debug" title="nm_debug()">nm_debug</a> (fmt, + args...) +#define <a class="link" href="libnm-util-nm-utils.html#nm-debug-str" title="nm_debug_str()">nm_debug_str</a> (fmt_str, + args...) +#define <a class="link" href="libnm-util-nm-utils.html#nm-warning" title="nm_warning()">nm_warning</a> (fmt, + args...) +#define <a class="link" href="libnm-util-nm-utils.html#nm-warning-str" title="nm_warning_str()">nm_warning_str</a> (fmt_str, + args...) +#define <a class="link" href="libnm-util-nm-utils.html#nm-error" title="nm_error()">nm_error</a> (fmt, + args...) +#define <a class="link" href="libnm-util-nm-utils.html#nm-error-str" title="nm_error_str()">nm_error_str</a> (fmt_str, + args...) <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libnm-util-nm-utils.html#nm-utils-init" title="nm_utils_init ()">nm_utils_init</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>); <span class="returnvalue">void</span> <a class="link" href="libnm-util-nm-utils.html#nm-utils-deinit" title="nm_utils_deinit ()">nm_utils_deinit</a> (<em class="parameter"><code><span class="type">void</span></code></em>); <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libnm-util-nm-utils.html#nm-utils-is-empty-ssid" title="nm_utils_is_empty_ssid ()">nm_utils_is_empty_ssid</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *ssid</code></em>, @@ -49,7 +67,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="libnm <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libnm-util-nm-utils.html#nm-utils-same-ssid" title="nm_utils_same_ssid ()">nm_utils_same_ssid</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GByteArray"><span class="type">GByteArray</span></a> *ssid1</code></em>, <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GByteArray"><span class="type">GByteArray</span></a> *ssid2</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> ignore_trailing_null</code></em>); -<span class="returnvalue">char</span> * <a class="link" href="libnm-util-nm-utils.html#nm-utils-ssid-to-utf8" title="nm_utils_ssid_to_utf8 ()">nm_utils_ssid_to_utf8</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GByteArray"><span class="type">GByteArray</span></a> *ssid</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="libnm-util-nm-utils.html#nm-utils-ssid-to-utf8" title="nm_utils_ssid_to_utf8 ()">nm_utils_ssid_to_utf8</a> (<em class="parameter"><code>const <span class="type">char</span> *ssid</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> len</code></em>); <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * <a class="link" href="libnm-util-nm-utils.html#nm-utils-gvalue-hash-dup" title="nm_utils_gvalue_hash_dup ()">nm_utils_gvalue_hash_dup</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *hash</code></em>); <span class="returnvalue">void</span> <a class="link" href="libnm-util-nm-utils.html#nm-utils-slist-free" title="nm_utils_slist_free ()">nm_utils_slist_free</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *list</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> elem_destroy_fn</code></em>); @@ -95,16 +114,216 @@ enum <a class="link" href="libnm-util-nm-utils.html#NMUtilsSecuri <em class="parameter"><code>const <span class="type">char</span> *band</code></em>); </pre> </div> -<div class="refsect1"> +<div class="refsect1" title="Description"> <a name="libnm-util-nm-utils.description"></a><h2>Description</h2> <p> A collection of utility functions for working SSIDs, IP addresses, WiFi access points and devices, among other things. </p> </div> -<div class="refsect1"> +<div class="refsect1" title="Details"> <a name="libnm-util-nm-utils.details"></a><h2>Details</h2> -<div class="refsect2"> +<div class="refsect2" title="nm_print_backtrace"> +<a name="nm-print-backtrace"></a><h3>nm_print_backtrace</h3> +<pre class="programlisting">#define nm_print_backtrace()</pre> +<p> +Prints a backtrace of the calling process to the logging location. +</p> +</div> +<hr> +<div class="refsect2" title="nm_get_timestamp()"> +<a name="nm-get-timestamp"></a><h3>nm_get_timestamp()</h3> +<pre class="programlisting">#define nm_get_timestamp(timestamp)</pre> +<p> +For debugging only. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td> +<td>location in which to place the current timestamp +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_info()"> +<a name="nm-info"></a><h3>nm_info()</h3> +<pre class="programlisting">#define nm_info(fmt, args...)</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>fmt</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>args...</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_info_str()"> +<a name="nm-info-str"></a><h3>nm_info_str()</h3> +<pre class="programlisting">#define nm_info_str(fmt_str, args...)</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>fmt_str</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>args...</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_debug()"> +<a name="nm-debug"></a><h3>nm_debug()</h3> +<pre class="programlisting">#define nm_debug(fmt, args...)</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>fmt</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>args...</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_debug_str()"> +<a name="nm-debug-str"></a><h3>nm_debug_str()</h3> +<pre class="programlisting">#define nm_debug_str(fmt_str, args...)</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>fmt_str</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>args...</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_warning()"> +<a name="nm-warning"></a><h3>nm_warning()</h3> +<pre class="programlisting">#define nm_warning(fmt, args...)</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>fmt</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>args...</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_warning_str()"> +<a name="nm-warning-str"></a><h3>nm_warning_str()</h3> +<pre class="programlisting">#define nm_warning_str(fmt_str, args...)</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>fmt_str</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>args...</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_error()"> +<a name="nm-error"></a><h3>nm_error()</h3> +<pre class="programlisting">#define nm_error(fmt, args...)</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>fmt</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>args...</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_error_str()"> +<a name="nm-error-str"></a><h3>nm_error_str()</h3> +<pre class="programlisting">#define nm_error_str(fmt_str, args...)</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>fmt_str</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>args...</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_utils_init ()"> <a name="nm-utils-init"></a><h3>nm_utils_init ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_utils_init (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> <p> @@ -123,13 +342,14 @@ libnm-util can also be done. This function can be called more than once. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>TRUE if the initialization was successful, FALSE on failure.</td> +<td> TRUE if the initialization was successful, FALSE on failure. +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_deinit ()"> <a name="nm-utils-deinit"></a><h3>nm_utils_deinit ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> nm_utils_deinit (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p> @@ -140,7 +360,7 @@ called again. </p> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_is_empty_ssid ()"> <a name="nm-utils-is-empty-ssid"></a><h3>nm_utils_is_empty_ssid ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_utils_is_empty_ssid (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *ssid</code></em>, <em class="parameter"><code><span class="type">int</span> len</code></em>);</pre> @@ -154,7 +374,8 @@ number of known SSID-cloaking methods. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>ssid</code></em> :</span></p></td> -<td>pointer to a buffer containing the SSID data</td> +<td>pointer to a buffer containing the SSID data +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td> @@ -163,13 +384,14 @@ number of known SSID-cloaking methods. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>TRUE if the SSID is "empty", FALSE if it is not</td> +<td> TRUE if the SSID is "empty", FALSE if it is not +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_escape_ssid ()"> <a name="nm-utils-escape-ssid"></a><h3>nm_utils_escape_ssid ()</h3> <pre class="programlisting">const <span class="returnvalue">char</span> * nm_utils_escape_ssid (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *ssid</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> len</code></em>);</pre> @@ -184,7 +406,8 @@ be used for display of SSIDs. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>ssid</code></em> :</span></p></td> -<td>pointer to a buffer containing the SSID data</td> +<td>pointer to a buffer containing the SSID data +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td> @@ -193,14 +416,15 @@ be used for display of SSIDs. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>pointer to the escaped SSID, which uses an internal static buffer -and will be overwritten by subsequent calls to this function</td> +<td> pointer to the escaped SSID, which uses an internal static buffer +and will be overwritten by subsequent calls to this function +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_same_ssid ()"> <a name="nm-utils-same-ssid"></a><h3>nm_utils_same_ssid ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_utils_same_ssid (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GByteArray"><span class="type">GByteArray</span></a> *ssid1</code></em>, <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GByteArray"><span class="type">GByteArray</span></a> *ssid2</code></em>, @@ -218,27 +442,32 @@ NULLs, even though that is functionally pointless. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>ssid1</code></em> :</span></p></td> -<td>first SSID data to compare</td> +<td>first SSID data to compare +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>ssid2</code></em> :</span></p></td> -<td>second SSID data to compare</td> +<td>second SSID data to compare +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>ignore_trailing_null</code></em> :</span></p></td> -<td>TRUE to ignore one trailing NULL byte</td> +<td>TRUE to ignore one trailing NULL byte +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>TRUE if the SSIDs are the same, FALSE if they are not</td> +<td> TRUE if the SSIDs are the same, FALSE if they are not +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_ssid_to_utf8 ()"> <a name="nm-utils-ssid-to-utf8"></a><h3>nm_utils_ssid_to_utf8 ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * nm_utils_ssid_to_utf8 (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GByteArray"><span class="type">GByteArray</span></a> *ssid</code></em>);</pre> +<pre class="programlisting"><span class="returnvalue">char</span> * nm_utils_ssid_to_utf8 (<em class="parameter"><code>const <span class="type">char</span> *ssid</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> len</code></em>);</pre> <p> WiFi SSIDs are byte arrays, they are _not_ strings. Thus, an SSID may contain embedded NULLs and other unprintable characters. Often it is @@ -271,20 +500,26 @@ _only_. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>ssid</code></em> :</span></p></td> -<td>a byte array containing the SSID data</td> +<td>pointer to a buffer containing the SSID data +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td> +<td>length of the SSID data in <em class="parameter"><code>ssid</code></em> +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>an allocated string containing a UTF-8 -representation of the SSID, which must be freed by the caller using <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>. -Returns NULL on errors. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +<td> an allocated string containing a UTF-8 representation of the +SSID, which must be freed by the caller using <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>. Returns NULL +on errors. </td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_gvalue_hash_dup ()"> <a name="nm-utils-gvalue-hash-dup"></a><h3>nm_utils_gvalue_hash_dup ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * nm_utils_gvalue_hash_dup (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *hash</code></em>);</pre> <p> @@ -295,19 +530,20 @@ Utility function to duplicate a hash table of GValues. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td> -<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> mapping string:GValue</td> +<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> mapping string:GValue +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a newly allocated duplicated <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a>, caller must free the -returned hash with <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#g-hash-table-unref"><code class="function">g_hash_table_unref()</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#g-hash-table-destroy"><code class="function">g_hash_table_destroy()</code></a>. <span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 GObject.Value]</span> +<td> a newly allocated duplicated <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a>, caller must free the +returned hash with <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#g-hash-table-unref"><code class="function">g_hash_table_unref()</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#g-hash-table-destroy"><code class="function">g_hash_table_destroy()</code></a> </td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_slist_free ()"> <a name="nm-utils-slist-free"></a><h3>nm_utils_slist_free ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> nm_utils_slist_free (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *list</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> elem_destroy_fn</code></em>);</pre> @@ -331,7 +567,7 @@ Utility function to free a <a href="http://library.gnome.org/devel/glib/unstable </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="enum NMUtilsSecurityType"> <a name="NMUtilsSecurityType"></a><h3>enum NMUtilsSecurityType</h3> <pre class="programlisting">typedef enum { NMU_SEC_INVALID = 0, @@ -349,7 +585,7 @@ Utility function to free a <a href="http://library.gnome.org/devel/glib/unstable </p> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_security_valid ()"> <a name="nm-utils-security-valid"></a><h3>nm_utils_security_valid ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_utils_security_valid (<em class="parameter"><code><a class="link" href="libnm-util-nm-utils.html#NMUtilsSecurityType" title="enum NMUtilsSecurityType"><span class="type">NMUtilsSecurityType</span></a> type</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> wifi_caps</code></em>, @@ -380,11 +616,13 @@ e.g. <span class="type">NMU_SEC_STATIC_WEP</span> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>have_ap</code></em> :</span></p></td> -<td>whether the <em class="parameter"><code>ap_flags</code></em>, <em class="parameter"><code>ap_wpa</code></em>, and <em class="parameter"><code>ap_rsn</code></em> arguments are valid</td> +<td>whether the <em class="parameter"><code>ap_flags</code></em>, <em class="parameter"><code>ap_wpa</code></em>, and <em class="parameter"><code>ap_rsn</code></em> arguments are valid +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>adhoc</code></em> :</span></p></td> -<td>whether the capabilities being tested are from an Ad-Hoc AP (IBSS)</td> +<td>whether the capabilities being tested are from an Ad-Hoc AP (IBSS) +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>ap_flags</code></em> :</span></p></td> @@ -394,29 +632,32 @@ e.g. <span class="type">NMU_SEC_STATIC_WEP</span> <tr> <td><p><span class="term"><em class="parameter"><code>ap_wpa</code></em> :</span></p></td> <td>bitfield of AP capabilties derived from the AP's WPA beacon, -e.g. (<span class="type">NM_802_11_AP_SEC_PAIR_TKIP</span> | <span class="type">NM_802_11_AP_SEC_KEY_MGMT_PSK</span>)</td> +e.g. (<span class="type">NM_802_11_AP_SEC_PAIR_TKIP</span> | <span class="type">NM_802_11_AP_SEC_KEY_MGMT_PSK</span>) +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>ap_rsn</code></em> :</span></p></td> <td>bitfield of AP capabilties derived from the AP's RSN/WPA2 beacon, -e.g. (<span class="type">NM_802_11_AP_SEC_PAIR_CCMP</span> | <span class="type">NM_802_11_AP_SEC_PAIR_TKIP</span>)</td> +e.g. (<span class="type">NM_802_11_AP_SEC_PAIR_CCMP</span> | <span class="type">NM_802_11_AP_SEC_PAIR_TKIP</span>) +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>TRUE if the device capabilities and AP capabilties intersect and are -compatible with the desired <em class="parameter"><code>type</code></em>, FALSE if they are not</td> +<td> TRUE if the device capabilities and AP capabilties intersect and are +compatible with the desired <em class="parameter"><code>type</code></em>, FALSE if they are not +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_ip4_addresses_from_gvalue ()"> <a name="nm-utils-ip4-addresses-from-gvalue"></a><h3>nm_utils_ip4_addresses_from_gvalue ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * nm_utils_ip4_addresses_from_gvalue (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre> <p> Utility function to convert a <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> of <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="type">GArrays</span></a> of guint32s representing a list of NetworkManager IPv4 addresses (which is a tuple of address, gateway, -and prefix) into a GSList of <a class="link" href="NMSettingIP4Config.html#NMIP4Address"><span class="type">NMIP4Address</span></a> objects. The specific format of +and prefix) into a GSList of <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> objects. The specific format of this serialization is not guaranteed to be stable and the <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="type">GArray</span></a> may be extended in the future. </p> @@ -425,23 +666,24 @@ extended in the future. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> -<td>gvalue containing a GPtrArray of GArrays of guint32s</td> +<td>gvalue containing a GPtrArray of GArrays of guint32s +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a newly allocated <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="NMSettingIP4Config.html#NMIP4Address"><span class="type">NMIP4Address</span></a> objects. <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> NetworkManager.IP4Address]</span> +<td> a newly allocated <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> objects </td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_ip4_addresses_to_gvalue ()"> <a name="nm-utils-ip4-addresses-to-gvalue"></a><h3>nm_utils_ip4_addresses_to_gvalue ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> nm_utils_ip4_addresses_to_gvalue (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *list</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre> <p> -Utility function to convert a <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="NMSettingIP4Config.html#NMIP4Address"><span class="type">NMIP4Address</span></a> objects into a +Utility function to convert a <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> objects into a GPtrArray of GArrays of guint32s representing a list of NetworkManager IPv4 addresses (which is a tuple of address, gateway, and prefix). The specific format of this serialization is not guaranteed to be stable and may be @@ -452,25 +694,27 @@ extended in the future. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> -<td>a list of <a class="link" href="NMSettingIP4Config.html#NMIP4Address"><span class="type">NMIP4Address</span></a> objects</td> +<td>a list of <a class="link" href="NMSettingIP4Config.html#NMIP4Address" title="NMIP4Address"><span class="type">NMIP4Address</span></a> objects +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> <td>a pointer to a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> into which to place the converted addresses, which should be unset by the caller (when no longer needed) with -<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#g-value-unset"><code class="function">g_value_unset()</code></a>.</td> +<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#g-value-unset"><code class="function">g_value_unset()</code></a>. +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_ip4_routes_from_gvalue ()"> <a name="nm-utils-ip4-routes-from-gvalue"></a><h3>nm_utils_ip4_routes_from_gvalue ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * nm_utils_ip4_routes_from_gvalue (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre> <p> Utility function to convert a GPtrArray of GArrays of guint32s representing a list of NetworkManager IPv4 routes (which is a tuple of route, next hop, -prefix, and metric) into a GSList of <a class="link" href="NMSettingIP4Config.html#NMIP4Route"><span class="type">NMIP4Route</span></a> objects. The specific +prefix, and metric) into a GSList of <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> objects. The specific format of this serialization is not guaranteed to be stable and may be extended in the future. </p> @@ -479,23 +723,24 @@ extended in the future. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> -<td>gvalue containing a GPtrArray of GArrays of guint32s</td> +<td>gvalue containing a GPtrArray of GArrays of guint32s +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a newly allocated <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="NMSettingIP4Config.html#NMIP4Route"><span class="type">NMIP4Route</span></a> objects. <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> NetworkManager.IP4Route]</span> +<td> a newly allocated <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> objects </td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_ip4_routes_to_gvalue ()"> <a name="nm-utils-ip4-routes-to-gvalue"></a><h3>nm_utils_ip4_routes_to_gvalue ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> nm_utils_ip4_routes_to_gvalue (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *list</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre> <p> -Utility function to convert a <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="NMSettingIP4Config.html#NMIP4Route"><span class="type">NMIP4Route</span></a> objects into a +Utility function to convert a <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> objects into a GPtrArray of GArrays of guint32s representing a list of NetworkManager IPv4 routes (which is a tuple of route, next hop, prefix, and metric). The specific format of this serialization is not guaranteed to be stable and may @@ -506,19 +751,21 @@ be extended in the future. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> -<td>a list of <a class="link" href="NMSettingIP4Config.html#NMIP4Route"><span class="type">NMIP4Route</span></a> objects</td> +<td>a list of <a class="link" href="NMSettingIP4Config.html#NMIP4Route" title="NMIP4Route"><span class="type">NMIP4Route</span></a> objects +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> <td>a pointer to a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> into which to place the converted routes, which should be unset by the caller (when no longer needed) with -<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#g-value-unset"><code class="function">g_value_unset()</code></a>.</td> +<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#g-value-unset"><code class="function">g_value_unset()</code></a>. +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_ip4_netmask_to_prefix ()"> <a name="nm-utils-ip4-netmask-to-prefix"></a><h3>nm_utils_ip4_netmask_to_prefix ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_utils_ip4_netmask_to_prefix (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> netmask</code></em>);</pre> <div class="variablelist"><table border="0"> @@ -526,17 +773,19 @@ which should be unset by the caller (when no longer needed) with <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>netmask</code></em> :</span></p></td> -<td>an IPv4 netmask in network byte order</td> +<td>an IPv4 netmask in network byte order +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the CIDR prefix represented by the netmask</td> +<td> the CIDR prefix represented by the netmask +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_ip4_prefix_to_netmask ()"> <a name="nm-utils-ip4-prefix-to-netmask"></a><h3>nm_utils_ip4_prefix_to_netmask ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_utils_ip4_prefix_to_netmask (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> prefix</code></em>);</pre> <div class="variablelist"><table border="0"> @@ -544,17 +793,19 @@ which should be unset by the caller (when no longer needed) with <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>prefix</code></em> :</span></p></td> -<td>a CIDR prefix</td> +<td>a CIDR prefix +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the netmask represented by the prefix</td> +<td> the netmask represented by the prefix +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_ip4_get_default_prefix ()"> <a name="nm-utils-ip4-get-default-prefix"></a><h3>nm_utils_ip4_get_default_prefix ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_utils_ip4_get_default_prefix (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> ip</code></em>);</pre> <p> @@ -568,23 +819,25 @@ falls in the predefined classes. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>ip</code></em> :</span></p></td> -<td>an IPv4 address (in network byte order)</td> +<td>an IPv4 address (in network byte order) +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the default class prefix for the given IP</td> +<td> the default class prefix for the given IP +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_ip6_addresses_from_gvalue ()"> <a name="nm-utils-ip6-addresses-from-gvalue"></a><h3>nm_utils_ip6_addresses_from_gvalue ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * nm_utils_ip6_addresses_from_gvalue (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre> <p> Utility function to convert a <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> of <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="type">GValueArrays</span></a> of (<a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="type">GArray</span></a> of guchars) and guint32 representing a list of NetworkManager IPv6 addresses (which is a tuple of address, -prefix, and gateway), into a GSList of <a class="link" href="NMSettingIP6Config.html#NMIP6Address"><span class="type">NMIP6Address</span></a> objects. The specific format of +prefix, and gateway), into a GSList of <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> objects. The specific format of this serialization is not guaranteed to be stable and the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="type">GValueArray</span></a> may be extended in the future. </p> @@ -593,23 +846,24 @@ extended in the future. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> -<td>gvalue containing a GPtrArray of GValueArrays of (GArray of guchars) and guint32</td> +<td>gvalue containing a GPtrArray of GValueArrays of (GArray of guchars) and guint32 +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a newly allocated <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="NMSettingIP6Config.html#NMIP6Address"><span class="type">NMIP6Address</span></a> objects. <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> NetworkManager.IP6Address]</span> +<td> a newly allocated <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> objects </td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_ip6_addresses_to_gvalue ()"> <a name="nm-utils-ip6-addresses-to-gvalue"></a><h3>nm_utils_ip6_addresses_to_gvalue ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> nm_utils_ip6_addresses_to_gvalue (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *list</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre> <p> -Utility function to convert a <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="NMSettingIP6Config.html#NMIP6Address"><span class="type">NMIP6Address</span></a> objects into a +Utility function to convert a <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> objects into a GPtrArray of GValueArrays representing a list of NetworkManager IPv6 addresses (which is a tuple of address, prefix, and gateway). The specific format of this serialization is not guaranteed to be stable and may be extended in the @@ -620,26 +874,28 @@ future. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> -<td>a list of <a class="link" href="NMSettingIP6Config.html#NMIP6Address"><span class="type">NMIP6Address</span></a> objects</td> +<td>a list of <a class="link" href="NMSettingIP6Config.html#NMIP6Address" title="NMIP6Address"><span class="type">NMIP6Address</span></a> objects +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> <td>a pointer to a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> into which to place the converted addresses, which should be unset by the caller (when no longer needed) with -<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#g-value-unset"><code class="function">g_value_unset()</code></a>.</td> +<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#g-value-unset"><code class="function">g_value_unset()</code></a>. +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_ip6_routes_from_gvalue ()"> <a name="nm-utils-ip6-routes-from-gvalue"></a><h3>nm_utils_ip6_routes_from_gvalue ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * nm_utils_ip6_routes_from_gvalue (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre> <p> Utility function GPtrArray of GValueArrays of (GArray or guchars), guint32, (GArray of guchars), and guint32 representing a list of NetworkManager IPv6 routes (which is a tuple of destination, prefix, next hop, and metric) -into a GSList of <a class="link" href="NMSettingIP6Config.html#NMIP6Route"><span class="type">NMIP6Route</span></a> objects. The specific format of this serialization +into a GSList of <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> objects. The specific format of this serialization is not guaranteed to be stable and may be extended in the future. </p> <div class="variablelist"><table border="0"> @@ -648,23 +904,24 @@ is not guaranteed to be stable and may be extended in the future. <tr> <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> <td>gvalue containing a GPtrArray of GValueArrays of (GArray or guchars), guint32, -(GArray of guchars), and guint32</td> +(GArray of guchars), and guint32 +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a newly allocated <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="NMSettingIP6Config.html#NMIP6Route"><span class="type">NMIP6Route</span></a> objects. <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> NetworkManager.IP6Route]</span> +<td> a newly allocated <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> objects </td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_ip6_routes_to_gvalue ()"> <a name="nm-utils-ip6-routes-to-gvalue"></a><h3>nm_utils_ip6_routes_to_gvalue ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> nm_utils_ip6_routes_to_gvalue (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *list</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre> <p> -Utility function to convert a <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="NMSettingIP6Config.html#NMIP6Route"><span class="type">NMIP6Route</span></a> objects into a GPtrArray of +Utility function to convert a <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> objects into a GPtrArray of GValueArrays of (GArray or guchars), guint32, (GArray of guchars), and guint32 representing a list of NetworkManager IPv6 routes (which is a tuple of destination, prefix, next hop, and metric). The specific format of this serialization is not @@ -675,48 +932,80 @@ guaranteed to be stable and may be extended in the future. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> -<td>a list of <a class="link" href="NMSettingIP6Config.html#NMIP6Route"><span class="type">NMIP6Route</span></a> objects</td> +<td>a list of <a class="link" href="NMSettingIP6Config.html#NMIP6Route" title="NMIP6Route"><span class="type">NMIP6Route</span></a> objects +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> <td>a pointer to a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> into which to place the converted routes, which should be unset by the caller (when no longer needed) with -<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#g-value-unset"><code class="function">g_value_unset()</code></a>.</td> +<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#g-value-unset"><code class="function">g_value_unset()</code></a>. +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_ip6_dns_from_gvalue ()"> <a name="nm-utils-ip6-dns-from-gvalue"></a><h3>nm_utils_ip6_dns_from_gvalue ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * nm_utils_ip6_dns_from_gvalue (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre> <p> </p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_ip6_dns_to_gvalue ()"> <a name="nm-utils-ip6-dns-to-gvalue"></a><h3>nm_utils_ip6_dns_to_gvalue ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> nm_utils_ip6_dns_to_gvalue (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *list</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre> <p> </p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_uuid_generate ()"> <a name="nm-utils-uuid-generate"></a><h3>nm_utils_uuid_generate ()</h3> <pre class="programlisting"><span class="returnvalue">char</span> * nm_utils_uuid_generate (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody><tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a newly allocated UUID suitable for use as the <a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> +<td> 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 <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> </td> </tr></tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_uuid_generate_from_string ()"> <a name="nm-utils-uuid-generate-from-string"></a><h3>nm_utils_uuid_generate_from_string ()</h3> <pre class="programlisting"><span class="returnvalue">char</span> * nm_utils_uuid_generate_from_string (<em class="parameter"><code>const <span class="type">char</span> *s</code></em>);</pre> <p> @@ -727,18 +1016,20 @@ For a given <em class="parameter"><code>s</code></em>, this function will always <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>s</code></em> :</span></p></td> -<td>a string to use as the seed for the UUID</td> +<td>a string to use as the seed for the UUID +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>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</td> +<td> 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 +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_rsa_key_encrypt ()"> <a name="nm-utils-rsa-key-encrypt"></a><h3>nm_utils_rsa_key_encrypt ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> * nm_utils_rsa_key_encrypt (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GByteArray"><span class="type">GByteArray</span></a> *data</code></em>, <em class="parameter"><code>const <span class="type">char</span> *in_password</code></em>, @@ -754,34 +1045,36 @@ suitable for writing to a file. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> -<td>RSA private key data to be encrypted</td> +<td>RSA private key data to be encrypted +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>in_password</code></em> :</span></p></td> -<td>existing password to use, if any. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span> +<td>existing password to use, if any </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>out_password</code></em> :</span></p></td> <td>if <em class="parameter"><code>in_password</code></em> was NULL, a random password will be generated -and returned in this argument. <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> + and returned in this argument </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> -<td>detailed error information on return, if an error occurred</td> +<td>detailed error information on return, if an error occurred +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>on success, PEM-formatted data suitable for writing to a PEM-formatted -certificate/private key file. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +<td> on success, PEM-formatted data suitable for writing to a PEM-formatted +certificate/private key file. </td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_wifi_freq_to_channel ()"> <a name="nm-utils-wifi-freq-to-channel"></a><h3>nm_utils_wifi_freq_to_channel ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_utils_wifi_freq_to_channel (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> freq</code></em>);</pre> <p> @@ -792,17 +1085,19 @@ Utility function to translate a WiFi frequency to its corresponding channel. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>freq</code></em> :</span></p></td> -<td>frequency</td> +<td>frequency +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the channel represented by the frequency or 0</td> +<td> the channel represented by the frequency or 0 +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_wifi_channel_to_freq ()"> <a name="nm-utils-wifi-channel-to-freq"></a><h3>nm_utils_wifi_channel_to_freq ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_utils_wifi_channel_to_freq (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> channel</code></em>, <em class="parameter"><code>const <span class="type">char</span> *band</code></em>);</pre> @@ -814,23 +1109,26 @@ Utility function to translate a WiFi channel to its corresponding frequency. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td> -<td>channel</td> +<td>channel +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>band</code></em> :</span></p></td> -<td>frequency band for wireless ("a" or "bg")</td> +<td>frequency band for wireless ("a" or "bg") +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the frequency represented by the channel of the band, -or -1 when the freq is invalid, or 0 when the band -is invalid</td> +<td> the frequency represented by the channel of the band, + or -1 when the freq is invalid, or 0 when the band + is invalid +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_wifi_find_next_channel ()"> <a name="nm-utils-wifi-find-next-channel"></a><h3>nm_utils_wifi_find_next_channel ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_utils_wifi_find_next_channel (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> channel</code></em>, <em class="parameter"><code><span class="type">int</span> direction</code></em>, @@ -843,25 +1141,29 @@ Utility function to find out next/previous WiFi channel for a channel. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td> -<td>current channel</td> +<td>current channel +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td> -<td>whether going downward (0 or less) or upward (1 or more)</td> +<td>whether going downward (0 or less) or upward (1 or more) +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>band</code></em> :</span></p></td> -<td>frequency band for wireless ("a" or "bg")</td> +<td>frequency band for wireless ("a" or "bg") +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the next channel in the specified direction or 0</td> +<td> the next channel in the specified direction or 0 +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_utils_wifi_is_channel_valid ()"> <a name="nm-utils-wifi-is-channel-valid"></a><h3>nm_utils_wifi_is_channel_valid ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_utils_wifi_is_channel_valid (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> channel</code></em>, <em class="parameter"><code>const <span class="type">char</span> *band</code></em>);</pre> @@ -873,15 +1175,18 @@ Utility function to verify WiFi channel validity. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td> -<td>channel</td> +<td>channel +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>band</code></em> :</span></p></td> -<td>frequency band for wireless ("a" or "bg")</td> +<td>frequency band for wireless ("a" or "bg") +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>TRUE or FALSE</td> +<td> TRUE or FALSE +</td> </tr> </tbody> </table></div> @@ -890,6 +1195,6 @@ Utility function to verify WiFi channel validity. </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.17</div> + Generated by GTK-Doc V1.15</div> </body> </html>
\ No newline at end of file |