Date: Mon, 24 Sep 2018 09:29:55 +0100 Subject: Import Upstream version 1.12.2 --- docs/libnm-util/html/libnm-util-nm-utils.html | 418 +++++++++++++------------- 1 file changed, 209 insertions(+), 209 deletions(-) (limited to 'docs/libnm-util/html/libnm-util-nm-utils.html') diff --git a/docs/libnm-util/html/libnm-util-nm-utils.html b/docs/libnm-util/html/libnm-util-nm-utils.html index fafbbeb7..44e801b4 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 @@ - + @@ -42,7 +42,7 @@ -gboolean +gboolean nm_utils_init () @@ -58,7 +58,7 @@ -gboolean +gboolean nm_utils_is_empty_ssid () @@ -73,7 +73,7 @@ -gboolean +gboolean nm_utils_same_ssid () @@ -89,7 +89,7 @@ -GHashTable * +GHashTable * nm_utils_gvalue_hash_dup () @@ -105,7 +105,7 @@ -gboolean +gboolean nm_utils_security_valid () @@ -113,7 +113,7 @@ -gboolean +gboolean nm_utils_ap_mode_security_valid () @@ -121,7 +121,7 @@ -gboolean +gboolean nm_utils_wep_key_valid () @@ -129,7 +129,7 @@ -gboolean +gboolean nm_utils_wpa_psk_valid () @@ -137,7 +137,7 @@ -GSList * +GSList * nm_utils_ip4_addresses_from_gvalue () @@ -153,7 +153,7 @@ -GSList * +GSList * nm_utils_ip4_routes_from_gvalue () @@ -169,7 +169,7 @@ -guint32 +guint32 nm_utils_ip4_netmask_to_prefix () @@ -177,7 +177,7 @@ -guint32 +guint32 nm_utils_ip4_prefix_to_netmask () @@ -185,7 +185,7 @@ -guint32 +guint32 nm_utils_ip4_get_default_prefix () @@ -193,7 +193,7 @@ -GSList * +GSList * nm_utils_ip6_addresses_from_gvalue () @@ -209,7 +209,7 @@ -GSList * +GSList * nm_utils_ip6_routes_from_gvalue () @@ -225,7 +225,7 @@ -GSList * +GSList * nm_utils_ip6_dns_from_gvalue () @@ -257,7 +257,7 @@ -GByteArray * +GByteArray * nm_utils_rsa_key_encrypt () @@ -265,7 +265,7 @@ -GByteArray * +GByteArray * nm_utils_rsa_key_encrypt_aes () @@ -273,7 +273,7 @@ -gboolean +gboolean nm_utils_file_is_pkcs12 () @@ -281,7 +281,7 @@ -gboolean +gboolean (*NMUtilsFileSearchInPathsPredicate) () @@ -296,7 +296,7 @@ -guint32 +guint32 nm_utils_wifi_freq_to_channel () @@ -304,7 +304,7 @@ -guint32 +guint32 nm_utils_wifi_channel_to_freq () @@ -312,7 +312,7 @@ -guint32 +guint32 nm_utils_wifi_find_next_channel () @@ -320,7 +320,7 @@ -gboolean +gboolean nm_utils_wifi_is_channel_valid () @@ -352,7 +352,7 @@ -GByteArray * +GByteArray * nm_utils_hwaddr_atoba () @@ -360,7 +360,7 @@ -guint8 * +guint8 * nm_utils_hwaddr_aton () @@ -376,7 +376,7 @@ -guint8 * +guint8 * nm_utils_hwaddr_aton_len () @@ -384,7 +384,7 @@ -gboolean +gboolean nm_utils_hwaddr_valid () @@ -416,7 +416,7 @@ -gboolean +gboolean nm_utils_iface_valid_name () @@ -424,7 +424,7 @@ -gboolean +gboolean nm_utils_is_uuid () @@ -446,7 +446,7 @@ -gboolean +gboolean nm_utils_check_virtual_device_compatibility () @@ -498,8 +498,8 @@ access points and devices, among other things.

Functions

nm_utils_init ()

gboolean
-nm_utils_init (GError **error);

gboolean
+nm_utils_init (GError **error);

Initializes libnm-util; should be called when starting any program that uses libnm-util. This function can be called more than once.

@@ -512,14 +512,14 @@ uses libnm-util. This function can be called more than once.

error

location to store error, or NULL

Returns

TRUE if the initialization was successful, FALSE on failure.

@@ -533,8 +533,8 @@ does not have any effect, and does not ever need to be called.

nm_utils_is_empty_ssid ()

gboolean
-nm_utils_is_empty_ssid (const guint8 *ssid,
+gboolean
+nm_utils_is_empty_ssid (const guint8 *ssid,
                         int len);
 Different manufacturers use different mechanisms for not broadcasting the
 AP's SSID.  This function attempts to detect blank/empty SSIDs using a
@@ -564,15 +564,15 @@ number of known SSID-cloaking methods.

Returns

TRUE if the SSID is "empty", FALSE if it is not

nm_utils_escape_ssid ()

const char *
-nm_utils_escape_ssid (const guint8 *ssid,
-                      guint32 len);

+nm_utils_escape_ssid (const guint8 *ssid, + guint32 len);

This function does a quick printable character conversion of the SSID, simply replacing embedded NULLs and non-printable characters with the hexadecimal representation of that character. Intended for debugging only, should not @@ -609,10 +609,10 @@ and will be overwritten by subsequent calls to this function

nm_utils_same_ssid ()

gboolean
-nm_utils_same_ssid (const GByteArray *ssid1,
-                    const GByteArray *ssid2,
-                    gboolean ignore_trailing_null);

gboolean
+nm_utils_same_ssid (const GByteArray *ssid1,
+                    const GByteArray *ssid2,
+                    gboolean ignore_trailing_null);

Earlier versions of the Linux kernel added a NULL byte to the end of the SSID to enable easy printing of the SSID on the console or in a terminal, but this behavior was problematic (SSIDs are simply byte arrays, not strings) @@ -640,7 +640,7 @@ NULLs, even though that is functionally pointless.

ignore_trailing_null

TRUE to ignore one trailing NULL byte

@@ -648,14 +648,14 @@ NULLs, even though that is functionally pointless.

Returns

TRUE if the SSIDs are the same, FALSE if they are not

nm_utils_ssid_to_utf8 ()

char *
-nm_utils_ssid_to_utf8 (const GByteArray *ssid);

+nm_utils_ssid_to_utf8 (const GByteArray *ssid);

Wi-Fi SSIDs are byte arrays, they are _not_ strings. Thus, an SSID may contain embedded NULLs and other unprintable characters. Often it is useful to print the SSID out for debugging purposes, but that should be the @@ -693,17 +693,17 @@ _only_.

Returns

an allocated string containing a UTF-8 -representation of the SSID, which must be freed by the caller using g_free(). -Returns NULL on errors.

+representation of the SSID, which must be freed by the caller using g_free(). +Returns NULL on errors.

[transfer full]

nm_utils_gvalue_hash_dup ()

GHashTable *
-nm_utils_gvalue_hash_dup (GHashTable *hash);

Utility function to duplicate a hash table of GValues.

GHashTable *
+nm_utils_gvalue_hash_dup (GHashTable *hash);

Utility function to duplicate a hash table of GValues.

Parameters

@@ -714,15 +714,15 @@ nm_utils_gvalue_hash_dup (hash -+

a GHashTable mapping string:GValue

Returns -a newly allocated duplicated GHashTable, caller must free the -returned hash with g_hash_table_unref() or g_hash_table_destroy(). +a newly allocated duplicated GHashTable, caller must free the +returned hash with g_hash_table_unref() or g_hash_table_destroy(). [transfer container][element-type utf8 GObject.Value]

@@ -730,13 +730,13 @@ returned hash with nm_utils_slist_free () void -nm_utils_slist_free (GSList *list, - GDestroyNotify elem_destroy_fn); +nm_utils_slist_free (GSList *list, + GDestroyNotify elem_destroy_fn); nm_utils_slist_free is deprecated and should not be used in newly-written code. -use g_slist_free_full(). +use g_slist_free_full(). -Utility function to free a GSList. +Utility function to free a GSList. [skip] Parameters @@ -749,7 +749,7 @@ nm_utils_slist_free (list -a GSList +a GSList @@ -765,11 +765,11 @@ nm_utils_slist_free ( nm_utils_security_valid () -gboolean +gboolean nm_utils_security_valid (NMUtilsSecurityType type, NMDeviceWifiCapabilities wifi_caps, - gboolean have_ap, - gboolean adhoc, + gboolean have_ap, + gboolean adhoc, NM80211ApFlags ap_flags, NM80211ApSecurityFlags ap_wpa, NM80211ApSecurityFlags ap_rsn); @@ -834,15 +834,15 @@ e.g. ( Returns - TRUE if the device capabilities and AP capabilties intersect and are + TRUE if the device capabilities and AP capabilties intersect and are compatible with the desired type -, FALSE if they are not +, FALSE if they are not nm_utils_ap_mode_security_valid () -gboolean +gboolean nm_utils_ap_mode_security_valid (NMUtilsSecurityType type, NMDeviceWifiCapabilities wifi_caps); Given a set of device capabilities, and a desired security type to check @@ -874,16 +874,16 @@ e.g. Returns - TRUE if the device capabilities are compatible with the desired + TRUE if the device capabilities are compatible with the desired type -, FALSE if they are not. +, FALSE if they are not. Since: 0.9.8 nm_utils_wep_key_valid () -gboolean +gboolean nm_utils_wep_key_valid (const char *key, NMWepKeyType wep_type); Checks if key @@ -912,15 +912,15 @@ nm_utils_wep_key_valid (const cha Returns - TRUE if key -is a WEP key, FALSE if not + TRUE if key +is a WEP key, FALSE if not Since: 0.9.8 nm_utils_wpa_psk_valid () -gboolean +gboolean nm_utils_wpa_psk_valid (const char *psk); Checks if psk is a valid WPA PSK @@ -941,20 +941,20 @@ nm_utils_wpa_psk_valid (const cha Returns - TRUE if psk -is a WPA PSK, FALSE if not + TRUE if psk +is a WPA PSK, FALSE if not Since: 0.9.8 nm_utils_ip4_addresses_from_gvalue () -GSList * -nm_utils_ip4_addresses_from_gvalue (const GValue *value); -Utility function to convert a GPtrArray of GArrays of guint32s representing + GSList * +nm_utils_ip4_addresses_from_gvalue (const GValue *value); +Utility function to convert a GPtrArray of GArrays of guint32s representing a list of NetworkManager IPv4 addresses (which is a tuple of address, gateway, -and prefix) into a GSList of NMIP4Address objects. The specific format of -this serialization is not guaranteed to be stable and the GArray may be +and prefix) into a GSList of NMIP4Address objects. The specific format of +this serialization is not guaranteed to be stable and the GArray may be extended in the future. Parameters @@ -966,14 +966,14 @@ extended in the future. value -GValue containing a GPtrArray of GArrays of guint32s +GValue containing a GPtrArray of GArrays of guint32s Returns -a newly allocated GSList of NMIP4Address objects. +a newly allocated GSList of NMIP4Address objects. [transfer full][element-type NMIP4Address] @@ -981,10 +981,10 @@ extended in the future. nm_utils_ip4_addresses_to_gvalue () void -nm_utils_ip4_addresses_to_gvalue (GSList *list, - GValue *value); -Utility function to convert a GSList of NMIP4Address objects into a -GPtrArray of GArrays of guint32s representing a list of NetworkManager IPv4 +nm_utils_ip4_addresses_to_gvalue (GSList *list, + GValue *value); + Utility function to convert a GSList of NMIP4Address 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 extended in the future. @@ -1004,9 +1004,9 @@ extended in the future. value -a pointer to a GValue into which to place the converted addresses, + a pointer to a GValue into which to place the converted addresses, which should be unset by the caller (when no longer needed) with -g_value_unset(). +g_value_unset(). @@ -1016,11 +1016,11 @@ which should be unset by the caller (when no longer needed) with nm_utils_ip4_routes_from_gvalue () -GSList * -nm_utils_ip4_routes_from_gvalue (const GValue *value); -Utility function to convert a GPtrArray of GArrays of guint32s representing + GSList * +nm_utils_ip4_routes_from_gvalue (const GValue *value); +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 NMIP4Route objects. The specific +prefix, and metric) into a GSList of NMIP4Route objects. The specific format of this serialization is not guaranteed to be stable and may be extended in the future. @@ -1033,14 +1033,14 @@ extended in the future. value -GValue containing a GPtrArray of GArrays of guint32s +GValue containing a GPtrArray of GArrays of guint32s Returns -a newly allocated GSList of NMIP4Route objects. +a newly allocated GSList of NMIP4Route objects. [transfer full][element-type NMIP4Route] @@ -1048,10 +1048,10 @@ extended in the future. nm_utils_ip4_routes_to_gvalue () void -nm_utils_ip4_routes_to_gvalue (GSList *list, - GValue *value); -Utility function to convert a GSList of NMIP4Route objects into a -GPtrArray of GArrays of guint32s representing a list of NetworkManager IPv4 +nm_utils_ip4_routes_to_gvalue (GSList *list, + GValue *value); + Utility function to convert a GSList of NMIP4Route 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 be extended in the future. @@ -1071,9 +1071,9 @@ be extended in the future. value -a pointer to a GValue into which to place the converted routes, + a pointer to a GValue into which to place the converted routes, which should be unset by the caller (when no longer needed) with -g_value_unset(). +g_value_unset(). @@ -1083,8 +1083,8 @@ which should be unset by the caller (when no longer needed) with nm_utils_ip4_netmask_to_prefix () -guint32 -nm_utils_ip4_netmask_to_prefix (guint32 netmask); +guint32 +nm_utils_ip4_netmask_to_prefix (guint32 netmask); Parameters @@ -1108,8 +1108,8 @@ nm_utils_ip4_netmask_to_prefix ( nm_utils_ip4_prefix_to_netmask () -guint32 -nm_utils_ip4_prefix_to_netmask (guint32 prefix); +guint32 +nm_utils_ip4_prefix_to_netmask (guint32 prefix); Parameters @@ -1133,8 +1133,8 @@ nm_utils_ip4_prefix_to_netmask ( nm_utils_ip4_get_default_prefix () -guint32 -nm_utils_ip4_get_default_prefix (guint32 ip); +guint32 +nm_utils_ip4_get_default_prefix (guint32 ip); When the Internet was originally set up, various ranges of IP addresses were segmented into three network classes: A, B, and C. This function will return a prefix that is associated with the IP address specified defining where it @@ -1162,12 +1162,12 @@ falls in the predefined classes. nm_utils_ip6_addresses_from_gvalue () -GSList * -nm_utils_ip6_addresses_from_gvalue (const GValue *value); -Utility function to convert a GPtrArray of GValueArrays of (GArray of guchars) and guint32 + GSList * +nm_utils_ip6_addresses_from_gvalue (const GValue *value); +Utility function to convert a GPtrArray of GValueArrays of (GArray of guchars) and guint32 representing a list of NetworkManager IPv6 addresses (which is a tuple of address, -prefix, and gateway), into a GSList of NMIP6Address objects. The specific format of -this serialization is not guaranteed to be stable and the GValueArray may be +prefix, and gateway), into a GSList of NMIP6Address objects. The specific format of +this serialization is not guaranteed to be stable and the GValueArray may be extended in the future. Parameters @@ -1179,14 +1179,14 @@ extended in the future. - + value gvalue containing a GPtrArray of GValueArrays of (GArray of guchars) and guint32 gvalue containing a GPtrArray of GValueArrays of (GArray of guchars) and guint32 Returns -a newly allocated GSList of NMIP6Address objects. +a newly allocated GSList of NMIP6Address objects. [transfer full][element-type NMIP6Address] @@ -1194,10 +1194,10 @@ extended in the future. nm_utils_ip6_addresses_to_gvalue () void -nm_utils_ip6_addresses_to_gvalue (GSList *list, - GValue *value); -Utility function to convert a GSList of NMIP6Address objects into a -GPtrArray of GValueArrays representing a list of NetworkManager IPv6 addresses +nm_utils_ip6_addresses_to_gvalue (GSList *list, + GValue *value); + Utility function to convert a GSList of NMIP6Address 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 future. @@ -1217,9 +1217,9 @@ future. value -a pointer to a GValue into which to place the converted addresses, + a pointer to a GValue into which to place the converted addresses, which should be unset by the caller (when no longer needed) with -g_value_unset(). +g_value_unset(). @@ -1229,12 +1229,12 @@ which should be unset by the caller (when no longer needed) with nm_utils_ip6_routes_from_gvalue () -GSList * -nm_utils_ip6_routes_from_gvalue (const GValue *value); -Utility function GPtrArray of GValueArrays of (GArray of guchars), guint32, -(GArray of guchars), and guint32 representing a list of NetworkManager IPv6 + GSList * +nm_utils_ip6_routes_from_gvalue (const GValue *value); +Utility function GPtrArray of GValueArrays of (GArray of 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 NMIP6Route objects. The specific format of this serialization +into a GSList of NMIP6Route objects. The specific format of this serialization is not guaranteed to be stable and may be extended in the future. Parameters @@ -1246,15 +1246,15 @@ is not guaranteed to be stable and may be extended in the future. value -GValue containing a GPtrArray of GValueArrays of (GArray of guchars), guint32, -(GArray of guchars), and guint32 +GValue containing a GPtrArray of GValueArrays of (GArray of guchars), guint32, +(GArray of guchars), and guint32 Returns -a newly allocated GSList of NMIP6Route objects. +a newly allocated GSList of NMIP6Route objects. [transfer full][element-type NMIP6Route] @@ -1262,10 +1262,10 @@ is not guaranteed to be stable and may be extended in the future. nm_utils_ip6_routes_to_gvalue () void -nm_utils_ip6_routes_to_gvalue (GSList *list, - GValue *value); -Utility function to convert a GSList of NMIP6Route objects into a GPtrArray of -GValueArrays of (GArray of guchars), guint32, (GArray of guchars), and guint32 +nm_utils_ip6_routes_to_gvalue (GSList *list, + GValue *value); + Utility function to convert a GSList of NMIP6Route objects into a GPtrArray of +GValueArrays of (GArray of 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 guaranteed to be stable and may be extended in the future. @@ -1285,9 +1285,9 @@ guaranteed to be stable and may be extended in the future. value -a pointer to a GValue into which to place the converted routes, + a pointer to a GValue into which to place the converted routes, which should be unset by the caller (when no longer needed) with -g_value_unset(). +g_value_unset(). @@ -1297,10 +1297,10 @@ which should be unset by the caller (when no longer needed) with nm_utils_ip6_dns_from_gvalue () -GSList * -nm_utils_ip6_dns_from_gvalue (const GValue *value); -Converts a GValue containing a GPtrArray of IP6 DNS, represented as -GByteArrays into a GSList of struct in6_addrs. +GSList * +nm_utils_ip6_dns_from_gvalue (const GValue *value); +Converts a GValue containing a GPtrArray of IP6 DNS, represented as +GByteArrays into a GSList of struct in6_addrs. [skip] Parameters @@ -1312,24 +1312,24 @@ nm_utils_ip6_dns_from_gvalue (const value -a GValue +a GValue Returns - a GSList of IP6 addresses. + a GSList of IP6 addresses. nm_utils_ip6_dns_to_gvalue () void -nm_utils_ip6_dns_to_gvalue (GSList *list, - GValue *value); -Utility function to convert a GSList of struct -in6_addr structs into a GPtrArray of GByteArrays +nm_utils_ip6_dns_to_gvalue (GSList *list, + GValue *value); + Utility function to convert a GSList of struct +in6_addr structs into a GPtrArray of GByteArrays representing each server's IPv6 addresses in network byte order. The specific format of this serialization is not guaranteed to be stable and may be extended in the future. @@ -1350,9 +1350,9 @@ stable and may be extended in the future. value -a pointer to a GValue into which to place the converted DNS server + a pointer to a GValue into which to place the converted DNS server addresses, which should be unset by the caller (when no longer needed) with -g_value_unset(). +g_value_unset(). @@ -1367,7 +1367,7 @@ nm_utils_uuid_generate (void Returns a newly allocated UUID suitable for use as the NMSettingConnection -object's “id”: property. Should be freed with g_free() +object's “id”: property. Should be freed with g_free() @@ -1401,11 +1401,11 @@ object's nm_utils_rsa_key_encrypt () -GByteArray * -nm_utils_rsa_key_encrypt (const GByteArray *data, +GByteArray * +nm_utils_rsa_key_encrypt (const GByteArray *data, const char *in_password, char **out_password, - GError **error); + GError **error); Encrypts the given RSA private key data with the given password (or generates a password if no password was given) and converts the data to PEM format suitable for writing to a file. It uses Triple DES cipher for the encryption. @@ -1431,7 +1431,7 @@ suitable for writing to a file. It uses Triple DES cipher for the encryption. out_password if in_password -was NULL, a random password will be generated +was NULL, a random password will be generated and returned in this argument. [out][allow-none] @@ -1453,11 +1453,11 @@ certificate/private key file. nm_utils_rsa_key_encrypt_aes () -GByteArray * -nm_utils_rsa_key_encrypt_aes (const GByteArray *data, +GByteArray * +nm_utils_rsa_key_encrypt_aes (const GByteArray *data, const char *in_password, char **out_password, - GError **error); + GError **error); Encrypts the given RSA private key data with the given password (or generates a password if no password was given) and converts the data to PEM format suitable for writing to a file. It uses AES cipher for the encryption. @@ -1483,7 +1483,7 @@ suitable for writing to a file. It uses AES cipher for the encryption. out_password if in_password -was NULL, a random password will be generated +was NULL, a random password will be generated and returned in this argument. [out][allow-none] @@ -1505,7 +1505,7 @@ certificate/private key file. nm_utils_file_is_pkcs12 () -gboolean +gboolean nm_utils_file_is_pkcs12 (const char *filename); Utility function to find out if the filename is in PKCS#12 format. @@ -1526,15 +1526,15 @@ nm_utils_file_is_pkcs12 (const ch Returns - TRUE if the file is PKCS#12, FALSE if it is not + TRUE if the file is PKCS#12, FALSE if it is not NMUtilsFileSearchInPathsPredicate () -gboolean +gboolean (*NMUtilsFileSearchInPathsPredicate) (const char *filename, - gpointer user_data); + gpointer user_data); @@ -1543,10 +1543,10 @@ nm_utils_file_is_pkcs12 (const ch nm_utils_file_search_in_paths (const char *progname, const char *try_first, const char *const *paths, - GFileTest file_test_flags, + GFileTest file_test_flags, NMUtilsFileSearchInPathsPredicate predicate, - gpointer user_data, - GError **error); + gpointer user_data, + GError **error); Searches for a progname file in a list of search paths . @@ -1573,16 +1573,16 @@ It is silently ignored if it is empty or not an absolute path. paths -a NULL terminated list of search paths. -Can be empty or NULL, in which case only try_first + a NULL terminated list of search paths. +Can be empty or NULL, in which case only try_first is checked. [allow-none] file_test_flags -the flags passed to g_file_test() when searching + the flags passed to g_file_test() when searching for progname -. Set it to 0 to skip the g_file_test(). +. Set it to 0 to skip the g_file_test(). @@ -1603,7 +1603,7 @@ function. error -on failure, set a "not found" error G_IO_ERROR G_IO_ERROR_NOT_FOUND. +on failure, set a "not found" error G_IO_ERROR G_IO_ERROR_NOT_FOUND. [allow-none] @@ -1611,7 +1611,7 @@ function. Returns -the full path to the helper, if found, or NULL if not found. + the full path to the helper, if found, or NULL if not found. The returned string is not owned by the caller, but later invocations of the function might overwrite it. [transfer none] @@ -1620,8 +1620,8 @@ invocations of the function might overwrite it. nm_utils_wifi_freq_to_channel () -guint32 -nm_utils_wifi_freq_to_channel (guint32 freq); +guint32 +nm_utils_wifi_freq_to_channel (guint32 freq); Utility function to translate a Wi-Fi frequency to its corresponding channel. Parameters @@ -1646,8 +1646,8 @@ nm_utils_wifi_freq_to_channel ( nm_utils_wifi_channel_to_freq () -guint32 -nm_utils_wifi_channel_to_freq (guint32 channel, +guint32 +nm_utils_wifi_channel_to_freq (guint32 channel, const char *band); Utility function to translate a Wi-Fi channel to its corresponding frequency. @@ -1682,8 +1682,8 @@ is invalid nm_utils_wifi_find_next_channel () -guint32 -nm_utils_wifi_find_next_channel (guint32 channel, +guint32 +nm_utils_wifi_find_next_channel (guint32 channel, int direction, char *band); Utility function to find out next/previous Wi-Fi channel for a channel. @@ -1722,8 +1722,8 @@ nm_utils_wifi_find_next_channel ( nm_utils_wifi_is_channel_valid () -gboolean -nm_utils_wifi_is_channel_valid (guint32 channel, +gboolean +nm_utils_wifi_is_channel_valid (guint32 channel, const char *band); Utility function to verify Wi-Fi channel validity. @@ -1750,7 +1750,7 @@ nm_utils_wifi_is_channel_valid ( Returns - TRUE or FALSE + TRUE or FALSE @@ -1823,7 +1823,7 @@ a length; but you can just use nm_utils_hwaddr_ntoa () char * -nm_utils_hwaddr_ntoa (gconstpointer addr, +nm_utils_hwaddr_ntoa (gconstpointer addr, int type); Converts addr to textual form. @@ -1862,12 +1862,12 @@ a type. nm_utils_hwaddr_atoba () -GByteArray * +GByteArray * nm_utils_hwaddr_atoba (const char *asc, int type); Parses asc - and converts it to binary form in a GByteArray. See -nm_utils_hwaddr_aton() if you don't want a GByteArray. + and converts it to binary form in a GByteArray. See +nm_utils_hwaddr_aton() if you don't want a GByteArray. Parameters @@ -1893,7 +1893,7 @@ nm_utils_hwaddr_atoba (const char Returns -a new GByteArray, or NULL if asc + a new GByteArray, or NULL if asc couldn't be parsed. [transfer full] @@ -1902,15 +1902,15 @@ be parsed. nm_utils_hwaddr_aton () -guint8 * +guint8 * nm_utils_hwaddr_aton (const char *asc, int type, - gpointer buffer); + gpointer buffer); Parses asc and converts it to binary form in buffer . See nm_utils_hwaddr_atoba() if you'd rather have the result in a -GByteArray. +GByteArray. See also nm_utils_hwaddr_aton_len(), which takes an output length instead of a type. @@ -1944,7 +1944,7 @@ instead of a type. Returns buffer -, or NULL if asc +, or NULL if asc couldn't be parsed @@ -1952,8 +1952,8 @@ couldn't be parsed nm_utils_hwaddr_ntoa_len () char * -nm_utils_hwaddr_ntoa_len (gconstpointer addr, - gsize length); +nm_utils_hwaddr_ntoa_len (gconstpointer addr, + gsize length); Converts addr to textual form. @@ -1990,10 +1990,10 @@ nm_utils_hwaddr_ntoa_len ( nm_utils_hwaddr_aton_len () -guint8 * +guint8 * nm_utils_hwaddr_aton_len (const char *asc, - gpointer buffer, - gsize length); + gpointer buffer, + gsize length); Parses asc and converts it to binary form in buffer . @@ -2030,7 +2030,7 @@ the size of the buffer in bytes. Returns buffer -, or NULL if asc +, or NULL if asc couldn't be parsed or would be shorter or longer than length . @@ -2040,7 +2040,7 @@ or would be shorter or longer than length nm_utils_hwaddr_valid () -gboolean +gboolean nm_utils_hwaddr_valid (const char *asc); Parses asc to see if it is a valid hardware address of some type. @@ -2061,9 +2061,9 @@ nm_utils_hwaddr_valid (const char Returns - TRUE if asc + TRUE if asc appears to be a valid hardware address -of some type, FALSE if not. +of some type, FALSE if not. Since: 0.9.10 @@ -2178,7 +2178,7 @@ string (it has to be even) Returns -a array of bytes, or NULL on error. +a array of bytes, or NULL on error. [transfer full] Since: 0.9.10 @@ -2186,7 +2186,7 @@ string (it has to be even) nm_utils_iface_valid_name () -gboolean +gboolean nm_utils_iface_valid_name (const char *name); This function is a 1:1 copy of the kernel's interface validation function in net/core/dev.c. @@ -2207,14 +2207,14 @@ function in net/core/dev.c. Returns - TRUE if interface name is valid, otherwise FALSE is returned. + TRUE if interface name is valid, otherwise FALSE is returned. Since: 0.9.8 nm_utils_is_uuid () -gboolean +gboolean nm_utils_is_uuid (const char *str); Checks if str is a UUID @@ -2235,8 +2235,8 @@ nm_utils_is_uuid (const char Returns - TRUE if str -is a UUID, FALSE if not + TRUE if str +is a UUID, FALSE if not Since: 0.9.8 @@ -2266,7 +2266,7 @@ nm_utils_inet4_ntop (in_addr_tdst Returns the input buffer dst , or a pointer to an -internal, static buffer. NULL is not allowed as in6addr +internal, static buffer. NULL is not allowed as in6addr , otherwise, this function cannot fail. @@ -2339,10 +2339,10 @@ otherwise, this function cannot fail. nm_utils_check_virtual_device_compatibility () -gboolean +gboolean nm_utils_check_virtual_device_compatibility - (GType virtual_type, - GType other_type); + (GType virtual_type, + GType other_type); Determines if a connection of type virtual_type can (in the general case) work with connections of type other_type @@ -2356,7 +2356,7 @@ general case) work with connections of type other_ty then this checks if other_type is a valid type for a slave of that master. -Note that even if this returns TRUE it is not guaranteed that + Note that even if this returns TRUE it is not guaranteed that every connection of type other_type is compatible with virtual_type @@ -2388,7 +2388,7 @@ underlying device driver. Returns - TRUE or FALSE + TRUE or FALSE Since: 0.9.10 @@ -2498,6 +2498,6 @@ for both - Generated by GTK-Doc V1.27 +Generated by GTK-Doc V1.28 \ No newline at end of file -- cgit 1.3.0-6-gf8a5 the destination buffer, it must contain at least INET_ADDRSTRLEN or NM_UTILS_INET_ADDRSTRLEN -characters. If set to NULL, it will return a pointer to an internal, static +characters. If set to NULL, it will return a pointer to an internal, static buffer (shared with nm_utils_inet6_ntop()). Beware, that the internal buffer will be overwritten with ever new call of nm_utils_inet4_ntop() or nm_utils_inet6_ntop() that does not provied it's own dst @@ -2313,7 +2313,7 @@ nm_utils_inet6_ntop (const struct dst the destination buffer, it must contain at least INET6_ADDRSTRLEN or NM_UTILS_INET_ADDRSTRLEN -characters. If set to NULL, it will return a pointer to an internal, static +characters. If set to NULL, it will return a pointer to an internal, static buffer (shared with nm_utils_inet4_ntop()). Beware, that the internal buffer will be overwritten with ever new call of nm_utils_inet4_ntop() or nm_utils_inet6_ntop() that does not provied it's own dst @@ -2330,7 +2330,7 @@ buffer to avoid these issues.