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 | 205 |
1 files changed, 147 insertions, 58 deletions
diff --git a/docs/libnm-util/html/libnm-util-nm-utils.html b/docs/libnm-util/html/libnm-util-nm-utils.html index 91e5b8f9..3d5c24ea 100644 --- a/docs/libnm-util/html/libnm-util-nm-utils.html +++ b/docs/libnm-util/html/libnm-util-nm-utils.html @@ -7,7 +7,7 @@ <link rel="home" href="index.html" title="libnm-util Reference Manual"> <link rel="up" href="ch01.html" title="libnm-util API Reference"> <link rel="prev" href="NMSettingVPN.html" title="NMSettingVPN"> -<link rel="next" href="object-tree.html" title="Object Hierarchy"> +<link rel="next" href="libnm-util-NetworkManager.html" title="NetworkManager"> <meta name="generator" content="GTK-Doc V1.19 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> @@ -18,7 +18,7 @@ <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">libnm-util Reference Manual</th> -<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<td><a accesskey="n" href="libnm-util-NetworkManager.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr> <tr><td colspan="5" class="shortcuts"> <a href="#libnm-util-nm-utils.synopsis" class="shortcut">Top</a> @@ -57,14 +57,14 @@ const <span class="returnvalue">char</span> * <a class="link" href="libnm <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>); enum <a class="link" href="libnm-util-nm-utils.html#NMUtilsSecurityType-enum" title="enum NMUtilsSecurityType">NMUtilsSecurityType</a>; <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-security-valid" title="nm_utils_security_valid ()">nm_utils_security_valid</a> (<em class="parameter"><code><a class="link" href="libnm-util-nm-utils.html#NMUtilsSecurityType"><span class="type">NMUtilsSecurityType</span></a> type</code></em>, - <em class="parameter"><code><span class="type">NMDeviceWifiCapabilities</span> wifi_caps</code></em>, + <em class="parameter"><code><a class="link" href="libnm-util-NetworkManager.html#NMDeviceWifiCapabilities" title="enum NMDeviceWifiCapabilities"><span class="type">NMDeviceWifiCapabilities</span></a> wifi_caps</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> have_ap</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> adhoc</code></em>, - <em class="parameter"><code><span class="type">NM80211ApFlags</span> ap_flags</code></em>, - <em class="parameter"><code><span class="type">NM80211ApSecurityFlags</span> ap_wpa</code></em>, - <em class="parameter"><code><span class="type">NM80211ApSecurityFlags</span> ap_rsn</code></em>); + <em class="parameter"><code><a class="link" href="libnm-util-NetworkManager.html#NM80211ApFlags" title="enum NM80211ApFlags"><span class="type">NM80211ApFlags</span></a> ap_flags</code></em>, + <em class="parameter"><code><a class="link" href="libnm-util-NetworkManager.html#NM80211ApSecurityFlags" title="enum NM80211ApSecurityFlags"><span class="type">NM80211ApSecurityFlags</span></a> ap_wpa</code></em>, + <em class="parameter"><code><a class="link" href="libnm-util-NetworkManager.html#NM80211ApSecurityFlags" title="enum NM80211ApSecurityFlags"><span class="type">NM80211ApSecurityFlags</span></a> ap_rsn</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-ap-mode-security-valid" title="nm_utils_ap_mode_security_valid ()">nm_utils_ap_mode_security_valid</a> (<em class="parameter"><code><a class="link" href="libnm-util-nm-utils.html#NMUtilsSecurityType"><span class="type">NMUtilsSecurityType</span></a> type</code></em>, - <em class="parameter"><code><span class="type">NMDeviceWifiCapabilities</span> wifi_caps</code></em>); + <em class="parameter"><code><a class="link" href="libnm-util-NetworkManager.html#NMDeviceWifiCapabilities" title="enum NMDeviceWifiCapabilities"><span class="type">NMDeviceWifiCapabilities</span></a> wifi_caps</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-wep-key-valid" title="nm_utils_wep_key_valid ()">nm_utils_wep_key_valid</a> (<em class="parameter"><code>const <span class="type">char</span> *key</code></em>, <em class="parameter"><code><a class="link" href="NMSettingWirelessSecurity.html#NMWepKeyType"><span class="type">NMWepKeyType</span></a> wep_type</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-wpa-psk-valid" title="nm_utils_wpa_psk_valid ()">nm_utils_wpa_psk_valid</a> (<em class="parameter"><code>const <span class="type">char</span> *psk</code></em>); @@ -97,6 +97,16 @@ enum <a class="link" href="libnm-util-nm-utils.html#NMUtilsSecuri <em class="parameter"><code><span class="type">char</span> **out_password</code></em>, <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>); <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-file-is-pkcs12" title="nm_utils_file_is_pkcs12 ()">nm_utils_file_is_pkcs12</a> (<em class="parameter"><code>const <span class="type">char</span> *filename</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#NMUtilsFileSearchInPathsPredicate" title="NMUtilsFileSearchInPathsPredicate ()">*NMUtilsFileSearchInPathsPredicate</a>) + (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="libnm-util-nm-utils.html#nm-utils-file-search-in-paths" title="nm_utils_file_search_in_paths ()">nm_utils_file_search_in_paths</a> (<em class="parameter"><code>const <span class="type">char</span> *progname</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *try_first</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *const *paths</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-File-Utilities.html#GFileTest"><span class="type">GFileTest</span></a> file_test_flags</code></em>, + <em class="parameter"><code><a class="link" href="libnm-util-nm-utils.html#NMUtilsFileSearchInPathsPredicate" title="NMUtilsFileSearchInPathsPredicate ()"><span class="type">NMUtilsFileSearchInPathsPredicate</span></a> predicate</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>, + <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>); <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="libnm-util-nm-utils.html#nm-utils-wifi-freq-to-channel" title="nm_utils_wifi_freq_to_channel ()">nm_utils_wifi_freq_to_channel</a> (<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>); <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="libnm-util-nm-utils.html#nm-utils-wifi-channel-to-freq" title="nm_utils_wifi_channel_to_freq ()">nm_utils_wifi_channel_to_freq</a> (<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>); @@ -149,7 +159,7 @@ const <span class="returnvalue">char</span> * <a class="link" href="libnm <div class="refsect1"> <a name="libnm-util-nm-utils.description"></a><h2>Description</h2> <p> -A collection of utility functions for working SSIDs, IP addresses, Wi-Fi +A collection of utility functions for working with SSIDs, IP addresses, Wi-Fi access points and devices, among other things. </p> </div> @@ -159,10 +169,8 @@ access points and devices, among other things. <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> -Initializes libnm-util; should be called when starting and program that -uses libnm-util. Sets up an <code class="function">atexit()</code> handler to ensure de-initialization -is performed, but calling <a class="link" href="libnm-util-nm-utils.html#nm-utils-deinit" title="nm_utils_deinit ()"><code class="function">nm_utils_deinit()</code></a> to explicitly deinitialize -libnm-util can also be done. This function can be called more than once. +Initializes libnm-util; should be called when starting any program that +uses libnm-util. This function can be called more than once. </p> <div class="variablelist"><table border="0" class="variablelist"> <colgroup> @@ -188,10 +196,8 @@ libnm-util can also be done. This function can be called more than once. <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> -Frees all resources used internally by libnm-util. This function is called -from an <code class="function">atexit()</code> handler, set up by <a class="link" href="libnm-util-nm-utils.html#nm-utils-init" title="nm_utils_init ()"><code class="function">nm_utils_init()</code></a>, but is safe to be called -more than once. Subsequent calls have no effect until <a class="link" href="libnm-util-nm-utils.html#nm-utils-init" title="nm_utils_init ()"><code class="function">nm_utils_init()</code></a> is -called again. +No-op. Although this function still exists for ABI compatibility reasons, it +does not have any effect, and does not ever need to be called. </p> </div> <hr> @@ -490,12 +496,12 @@ generating the dynamic WEP keys automatically <div class="refsect2"> <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"><span class="type">NMUtilsSecurityType</span></a> type</code></em>, - <em class="parameter"><code><span class="type">NMDeviceWifiCapabilities</span> wifi_caps</code></em>, + <em class="parameter"><code><a class="link" href="libnm-util-NetworkManager.html#NMDeviceWifiCapabilities" title="enum NMDeviceWifiCapabilities"><span class="type">NMDeviceWifiCapabilities</span></a> wifi_caps</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> have_ap</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> adhoc</code></em>, - <em class="parameter"><code><span class="type">NM80211ApFlags</span> ap_flags</code></em>, - <em class="parameter"><code><span class="type">NM80211ApSecurityFlags</span> ap_wpa</code></em>, - <em class="parameter"><code><span class="type">NM80211ApSecurityFlags</span> ap_rsn</code></em>);</pre> + <em class="parameter"><code><a class="link" href="libnm-util-NetworkManager.html#NM80211ApFlags" title="enum NM80211ApFlags"><span class="type">NM80211ApFlags</span></a> ap_flags</code></em>, + <em class="parameter"><code><a class="link" href="libnm-util-NetworkManager.html#NM80211ApSecurityFlags" title="enum NM80211ApSecurityFlags"><span class="type">NM80211ApSecurityFlags</span></a> ap_wpa</code></em>, + <em class="parameter"><code><a class="link" href="libnm-util-NetworkManager.html#NM80211ApSecurityFlags" title="enum NM80211ApSecurityFlags"><span class="type">NM80211ApSecurityFlags</span></a> ap_rsn</code></em>);</pre> <p> Given a set of device capabilities, and a desired security type to check against, determines whether the combination of device, desired security @@ -520,7 +526,7 @@ e.g. <a class="link" href="libnm-util-nm-utils.html#NMU-SEC-STATIC-WEP:CAPS"><sp <tr> <td><p><span class="term"><em class="parameter"><code>wifi_caps</code></em> :</span></p></td> <td>bitfield of the capabilities of the specific Wi-Fi device, e.g. -<span class="type">NM_WIFI_DEVICE_CAP_CIPHER_WEP40</span> +<a class="link" href="libnm-util-NetworkManager.html#NM-WIFI-DEVICE-CAP-CIPHER-WEP40:CAPS"><span class="type">NM_WIFI_DEVICE_CAP_CIPHER_WEP40</span></a> </td> </tr> <tr> @@ -533,18 +539,18 @@ e.g. <a class="link" href="libnm-util-nm-utils.html#NMU-SEC-STATIC-WEP:CAPS"><sp </tr> <tr> <td><p><span class="term"><em class="parameter"><code>ap_flags</code></em> :</span></p></td> -<td>bitfield of AP capabilities, e.g. <span class="type">NM_802_11_AP_FLAGS_PRIVACY</span> +<td>bitfield of AP capabilities, e.g. <a class="link" href="libnm-util-NetworkManager.html#NM-802-11-AP-FLAGS-PRIVACY:CAPS"><span class="type">NM_802_11_AP_FLAGS_PRIVACY</span></a> </td> </tr> <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. (<a class="link" href="libnm-util-NetworkManager.html#NM-802-11-AP-SEC-PAIR-TKIP:CAPS"><span class="type">NM_802_11_AP_SEC_PAIR_TKIP</span></a> | <a class="link" href="libnm-util-NetworkManager.html#NM-802-11-AP-SEC-KEY-MGMT-PSK:CAPS"><span class="type">NM_802_11_AP_SEC_KEY_MGMT_PSK</span></a>)</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. (<a class="link" href="libnm-util-NetworkManager.html#NM-802-11-AP-SEC-PAIR-CCMP:CAPS"><span class="type">NM_802_11_AP_SEC_PAIR_CCMP</span></a> | <a class="link" href="libnm-util-NetworkManager.html#NM-802-11-AP-SEC-PAIR-TKIP:CAPS"><span class="type">NM_802_11_AP_SEC_PAIR_TKIP</span></a>)</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> @@ -559,7 +565,7 @@ compatible with the desired <em class="parameter"><code>type</code></em>, <a hre <div class="refsect2"> <a name="nm-utils-ap-mode-security-valid"></a><h3>nm_utils_ap_mode_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_ap_mode_security_valid (<em class="parameter"><code><a class="link" href="libnm-util-nm-utils.html#NMUtilsSecurityType"><span class="type">NMUtilsSecurityType</span></a> type</code></em>, - <em class="parameter"><code><span class="type">NMDeviceWifiCapabilities</span> wifi_caps</code></em>);</pre> + <em class="parameter"><code><a class="link" href="libnm-util-NetworkManager.html#NMDeviceWifiCapabilities" title="enum NMDeviceWifiCapabilities"><span class="type">NMDeviceWifiCapabilities</span></a> wifi_caps</code></em>);</pre> <p> Given a set of device capabilities, and a desired security type to check against, determines whether the combination of device capabilities and @@ -580,7 +586,7 @@ e.g. <a class="link" href="libnm-util-nm-utils.html#NMU-SEC-STATIC-WEP:CAPS"><sp <tr> <td><p><span class="term"><em class="parameter"><code>wifi_caps</code></em> :</span></p></td> <td>bitfield of the capabilities of the specific Wi-Fi device, e.g. -<span class="type">NM_WIFI_DEVICE_CAP_CIPHER_WEP40</span> +<a class="link" href="libnm-util-NetworkManager.html#NM-WIFI-DEVICE-CAP-CIPHER-WEP40:CAPS"><span class="type">NM_WIFI_DEVICE_CAP_CIPHER_WEP40</span></a> </td> </tr> <tr> @@ -675,7 +681,7 @@ extended in the future. </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"><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> NMIP4Address]</span> </td> </tr> </tbody> @@ -738,7 +744,7 @@ extended in the future. </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"><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> NMIP4Route]</span> </td> </tr> </tbody> @@ -869,7 +875,7 @@ extended in the future. </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"><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> NMIP6Address]</span> </td> </tr> </tbody> @@ -933,7 +939,7 @@ is not guaranteed to be stable and may be extended in the future. </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"><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> NMIP6Route]</span> </td> </tr> </tbody> @@ -948,7 +954,7 @@ is not guaranteed to be stable and may be extended in the future. 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 <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 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchars</span></a>), <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a>, (<a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="type">GArray</span></a> of <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchars</span></a>), and <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> 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 +prefix, next hop, and metric). 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" class="variablelist"> @@ -1167,7 +1173,7 @@ certificate/private key file. <span class="annotation">[<acronym title="Free dat <a name="nm-utils-file-is-pkcs12"></a><h3>nm_utils_file_is_pkcs12 ()</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_file_is_pkcs12 (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>);</pre> <p> -Utility function to find out if the <em class="parameter"><code>filename</code></em> is in PKCS<span class="type">12</span> format. +Utility function to find out if the <em class="parameter"><code>filename</code></em> is in PKCS#12 format. </p> <div class="variablelist"><table border="0" class="variablelist"> <colgroup> @@ -1182,7 +1188,84 @@ Utility function to find out if the <em class="parameter"><code>filename</code>< <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the file is PKCS<span class="type">12</span>, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it is not</td> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the file is PKCS#12, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it is not</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="NMUtilsFileSearchInPathsPredicate"></a><h3>NMUtilsFileSearchInPathsPredicate ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (*NMUtilsFileSearchInPathsPredicate) + (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> +<p> +</p> +</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>, + <em class="parameter"><code>const <span class="type">char</span> *try_first</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *const *paths</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-File-Utilities.html#GFileTest"><span class="type">GFileTest</span></a> file_test_flags</code></em>, + <em class="parameter"><code><a class="link" href="libnm-util-nm-utils.html#NMUtilsFileSearchInPathsPredicate" title="NMUtilsFileSearchInPathsPredicate ()"><span class="type">NMUtilsFileSearchInPathsPredicate</span></a> predicate</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>, + <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> +Searches for a <em class="parameter"><code>progname</code></em> file in a list of search <em class="parameter"><code>paths</code></em>. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>progname</code></em> :</span></p></td> +<td>the helper program name, like "iptables" +Must be a non-empty string, without path separator (/).</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>try_first</code></em> :</span></p></td> +<td>a custom path to try first before searching. +It is silently ignored if it is empty or not an absolute path. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>paths</code></em> :</span></p></td> +<td>a <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated list of search paths. +Can be empty or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, in which case only <em class="parameter"><code>try_first</code></em> is checked. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>file_test_flags</code></em> :</span></p></td> +<td>the flags passed to <a href="http://library.gnome.org/devel/glib/unstable/glib-File-Utilities.html#g-file-test"><code class="function">g_file_test()</code></a> when searching +for <em class="parameter"><code>progname</code></em>. Set it to 0 to skip the <a href="http://library.gnome.org/devel/glib/unstable/glib-File-Utilities.html#g-file-test"><code class="function">g_file_test()</code></a>.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>predicate</code></em> :</span></p></td> +<td>if given, pass the file name to this function +for additional checks. This check is performed after the check for +<em class="parameter"><code>file_test_flags</code></em>. You cannot omit both <em class="parameter"><code>file_test_flags</code></em> and <em class="parameter"><code>predicate</code></em>. <span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>(allow-none): user data for <em class="parameter"><code>predicate</code></em> function. <span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> +<td>on failure, a "not found" error using <em class="parameter"><code>error_domain</code></em> and <em class="parameter"><code>error_code</code></em> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the full path to the helper, if found, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if not found. +The returned string is not owned by the caller, but later +invocations of the function might overwrite it. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> </tr> </tbody> </table></div> @@ -1313,9 +1396,8 @@ Utility function to verify Wi-Fi channel validity. <pre class="programlisting">#define NM_UTILS_HWADDR_LEN_MAX 20 /* INFINIBAND_ALEN */ </pre> <p> -The maximum length of a hardware address of a type known by -<a class="link" href="libnm-util-nm-utils.html#nm-utils-hwaddr-len" title="nm_utils_hwaddr_len ()"><code class="function">nm_utils_hwaddr_len()</code></a> or <a class="link" href="libnm-util-nm-utils.html#nm-utils-hwaddr-aton" title="nm_utils_hwaddr_aton ()"><code class="function">nm_utils_hwaddr_aton()</code></a>. This can be used -as the size of the buffer passed to <a class="link" href="libnm-util-nm-utils.html#nm-utils-hwaddr-aton" title="nm_utils_hwaddr_aton ()"><code class="function">nm_utils_hwaddr_aton()</code></a>. +The maximum length of hardware addresses handled by NetworkManager itself, +<a class="link" href="libnm-util-nm-utils.html#nm-utils-hwaddr-len" title="nm_utils_hwaddr_len ()"><code class="function">nm_utils_hwaddr_len()</code></a>, and <a class="link" href="libnm-util-nm-utils.html#nm-utils-hwaddr-aton" title="nm_utils_hwaddr_aton ()"><code class="function">nm_utils_hwaddr_aton()</code></a>. </p> </div> <hr> @@ -1333,7 +1415,8 @@ Returns the length in octets of a hardware address of type <em class="parameter" <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> -<td>the type of address; either <code class="literal">ARPHRD_ETHER</code> or <code class="literal">ARPHRD_INFINIBAND</code> +<td>the type of address; either <code class="literal">ARPHRD_ETHER</code> or +<code class="literal">ARPHRD_INFINIBAND</code> </td> </tr> <tr> @@ -1357,8 +1440,8 @@ a length; but you can just use <a class="link" href="libnm-util-nm-utils.html#nm <a class="link" href="libnm-util-nm-utils.html#nm-utils-hwaddr-aton-len" title="nm_utils_hwaddr_aton_len ()"><code class="function">nm_utils_hwaddr_aton_len()</code></a> now instead.</p> </div> <p> -Returns the type (either <code class="literal">ARPHRD_ETHER</code> or <code class="literal">ARPHRD_INFINIBAND</code>) of -the raw address given its length. +Returns the type (either <code class="literal">ARPHRD_ETHER</code> or +<code class="literal">ARPHRD_INFINIBAND</code>) of the raw address given its length. </p> <div class="variablelist"><table border="0" class="variablelist"> <colgroup> @@ -1372,8 +1455,9 @@ the raw address given its length. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the type, either <code class="literal">ARPHRD_ETHER</code> or <code class="literal">ARPHRD_INFINIBAND</code>. -If the length is unexpected, return -1 (unsupported type/length).</td> +<td>the type, either <code class="literal">ARPHRD_ETHER</code> or +<code class="literal">ARPHRD_INFINIBAND</code>. If the length is unexpected, return -1 +(unsupported type/length).</td> </tr> </tbody> </table></div> @@ -1402,7 +1486,8 @@ a type. </tr> <tr> <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> -<td>the type of address; either <code class="literal">ARPHRD_ETHER</code> or <code class="literal">ARPHRD_INFINIBAND</code> +<td>the type of address; either <code class="literal">ARPHRD_ETHER</code> or +<code class="literal">ARPHRD_INFINIBAND</code> </td> </tr> <tr> @@ -1434,7 +1519,8 @@ Parses <em class="parameter"><code>asc</code></em> and converts it to binary for </tr> <tr> <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> -<td>the type of address; either <code class="literal">ARPHRD_ETHER</code> or <code class="literal">ARPHRD_INFINIBAND</code> +<td>the type of address; either <code class="literal">ARPHRD_ETHER</code> or +<code class="literal">ARPHRD_INFINIBAND</code> </td> </tr> <tr> @@ -1473,7 +1559,8 @@ instead of a type. </tr> <tr> <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> -<td>the type of address; either <code class="literal">ARPHRD_ETHER</code> or <code class="literal">ARPHRD_INFINIBAND</code> +<td>the type of address; either <code class="literal">ARPHRD_ETHER</code> or +<code class="literal">ARPHRD_INFINIBAND</code> </td> </tr> <tr> @@ -1764,13 +1851,14 @@ Wrapper for inet_ntop. </tr> <tr> <td><p><span class="term"><em class="parameter"><code>dst</code></em> :</span></p></td> -<td>the destination buffer, it must contain at least <code class="literal">INET_ADDRSTRLEN</code> -or <a class="link" href="libnm-util-nm-utils.html#NM-UTILS-INET-ADDRSTRLEN:CAPS" title="NM_UTILS_INET_ADDRSTRLEN"><code class="literal">NM_UTILS_INET_ADDRSTRLEN</code></a> characters. If set to <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, it will return -a pointer to an internal, static buffer (shared with <a class="link" href="libnm-util-nm-utils.html#nm-utils-inet6-ntop" title="nm_utils_inet6_ntop ()"><code class="function">nm_utils_inet6_ntop()</code></a>). -Beware, that the internal buffer will be overwritten with ever new call -of <a class="link" href="libnm-util-nm-utils.html#nm-utils-inet4-ntop" title="nm_utils_inet4_ntop ()"><code class="function">nm_utils_inet4_ntop()</code></a> or <a class="link" href="libnm-util-nm-utils.html#nm-utils-inet6-ntop" title="nm_utils_inet6_ntop ()"><code class="function">nm_utils_inet6_ntop()</code></a> that does not provied it's -own <em class="parameter"><code>dst</code></em> buffer. Also, using the internal buffer is not thread safe. When -in doubt, pass your own <em class="parameter"><code>dst</code></em> buffer to avoid these issues.</td> +<td>the destination buffer, it must contain at least +<code class="literal">INET_ADDRSTRLEN</code> or <a class="link" href="libnm-util-nm-utils.html#NM-UTILS-INET-ADDRSTRLEN:CAPS" title="NM_UTILS_INET_ADDRSTRLEN"><code class="literal">NM_UTILS_INET_ADDRSTRLEN</code></a> +characters. If set to <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, it will return a pointer to an internal, static +buffer (shared with <a class="link" href="libnm-util-nm-utils.html#nm-utils-inet6-ntop" title="nm_utils_inet6_ntop ()"><code class="function">nm_utils_inet6_ntop()</code></a>). Beware, that the internal +buffer will be overwritten with ever new call of <a class="link" href="libnm-util-nm-utils.html#nm-utils-inet4-ntop" title="nm_utils_inet4_ntop ()"><code class="function">nm_utils_inet4_ntop()</code></a> or +<a class="link" href="libnm-util-nm-utils.html#nm-utils-inet6-ntop" title="nm_utils_inet6_ntop ()"><code class="function">nm_utils_inet6_ntop()</code></a> that does not provied it's own <em class="parameter"><code>dst</code></em> buffer. Also, +using the internal buffer is not thread safe. When in doubt, pass your own +<em class="parameter"><code>dst</code></em> buffer to avoid these issues.</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> @@ -1801,13 +1889,14 @@ Wrapper for inet_ntop. </tr> <tr> <td><p><span class="term"><em class="parameter"><code>dst</code></em> :</span></p></td> -<td>the destination buffer, it must contain at least <code class="literal">INET6_ADDRSTRLEN</code> -or <a class="link" href="libnm-util-nm-utils.html#NM-UTILS-INET-ADDRSTRLEN:CAPS" title="NM_UTILS_INET_ADDRSTRLEN"><code class="literal">NM_UTILS_INET_ADDRSTRLEN</code></a> characters. If set to <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, it will return -a pointer to an internal, static buffer (shared with <a class="link" href="libnm-util-nm-utils.html#nm-utils-inet4-ntop" title="nm_utils_inet4_ntop ()"><code class="function">nm_utils_inet4_ntop()</code></a>). -Beware, that the internal buffer will be overwritten with ever new call -of <a class="link" href="libnm-util-nm-utils.html#nm-utils-inet4-ntop" title="nm_utils_inet4_ntop ()"><code class="function">nm_utils_inet4_ntop()</code></a> or <a class="link" href="libnm-util-nm-utils.html#nm-utils-inet6-ntop" title="nm_utils_inet6_ntop ()"><code class="function">nm_utils_inet6_ntop()</code></a> that does not provied it's -own <em class="parameter"><code>dst</code></em> buffer. Also, using the internal buffer is not thread safe. When -in doubt, pass your own <em class="parameter"><code>dst</code></em> buffer to avoid these issues.</td> +<td>the destination buffer, it must contain at least +<code class="literal">INET6_ADDRSTRLEN</code> or <a class="link" href="libnm-util-nm-utils.html#NM-UTILS-INET-ADDRSTRLEN:CAPS" title="NM_UTILS_INET_ADDRSTRLEN"><code class="literal">NM_UTILS_INET_ADDRSTRLEN</code></a> +characters. If set to <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, it will return a pointer to an internal, static +buffer (shared with <a class="link" href="libnm-util-nm-utils.html#nm-utils-inet4-ntop" title="nm_utils_inet4_ntop ()"><code class="function">nm_utils_inet4_ntop()</code></a>). Beware, that the internal +buffer will be overwritten with ever new call of <a class="link" href="libnm-util-nm-utils.html#nm-utils-inet4-ntop" title="nm_utils_inet4_ntop ()"><code class="function">nm_utils_inet4_ntop()</code></a> or +<a class="link" href="libnm-util-nm-utils.html#nm-utils-inet6-ntop" title="nm_utils_inet6_ntop ()"><code class="function">nm_utils_inet6_ntop()</code></a> that does not provied it's own <em class="parameter"><code>dst</code></em> buffer. Also, +using the internal buffer is not thread safe. When in doubt, pass your own +<em class="parameter"><code>dst</code></em> buffer to avoid these issues.</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |