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.

@@ -769,7 +769,7 @@ type, and AP capabilities intersect.

NOTE: this function cannot handle checking security for AP/Hotspot mode; use nm_utils_ap_mode_security_valid() instead.

Parameters

@@ -823,7 +823,7 @@ e.g. ( -

Returns

TRUE if the device capabilities and AP capabilties intersect and are compatible with the desired type , FALSE if they are not

@@ -839,7 +839,7 @@ nm_utils_ap_mode_security_valid (-Parameters +Parameters

@@ -863,7 +863,7 @@ e.g. -Returns +Returns TRUE if the device capabilities are compatible with the desired type , FALSE if they are not. @@ -878,7 +878,7 @@ nm_utils_wep_key_valid (const cha Checks if key is a valid WEP key -Parameters +Parameters

@@ -900,7 +900,7 @@ nm_utils_wep_key_valid (const cha

-Returns +Returns TRUE if key is a WEP key, FALSE if not @@ -913,7 +913,7 @@ nm_utils_wpa_psk_valid (const cha Checks if psk is a valid WPA PSK -Parameters +Parameters @@ -928,7 +928,7 @@ nm_utils_wpa_psk_valid (const cha -Returns +Returns TRUE if psk is a WPA PSK, FALSE if not @@ -941,7 +941,7 @@ nm_utils_ip4_dns_to_variant (char Utility function to convert an array of IP address strings int a GVariant of type 'au' representing an array of IPv4 addresses. -Parameters +Parameters @@ -956,7 +956,7 @@ type 'au' representing an array of IPv4 addresses. -Returns +Returns a new floating GVariant representing dns . [transfer none] @@ -970,7 +970,7 @@ nm_utils_ip4_dns_from_variant (GV Utility function to convert a GVariant of type 'au' representing a list of IPv4 addresses into an array of IP address strings. -Parameters +Parameters @@ -985,7 +985,7 @@ IPv4 addresses into an array of IP address strings. -Returns +Returns a NULL-terminated array of IP address strings. [transfer full][type utf8] @@ -1003,7 +1003,7 @@ gateway). The "gateway" field of the first address will get the value of gateway (if non-NULL). In all of the other addresses, that field will be 0. -Parameters +Parameters @@ -1025,7 +1025,7 @@ gateway). The "gateway" field of the first address will get the value of -Returns +Returns a new floating GVariant representing addresses . [transfer none] @@ -1044,7 +1044,7 @@ the first address (if set) will be returned in out_g ; the "gateway" fields of the other addresses are ignored. -Parameters +Parameters @@ -1066,7 +1066,7 @@ of the other addresses are ignored. -Returns +Returns a newly allocated GPtrArray of NMIPAddress objects. [transfer full][element-type NMIPAddress] @@ -1082,7 +1082,7 @@ IPv4 routes into a GVariant of type 'aau' representing NetworkManager IPv4 routes (which are tuples of route, prefix, next hop, and metric). -Parameters +Parameters @@ -1091,13 +1091,13 @@ metric). - + routes an array of NMIP4Route objects. an array of NMIP4Route objects. [element-type NMIPRoute] -Returns +Returns a new floating GVariant representing routes . [transfer none] @@ -1112,7 +1112,7 @@ nm_utils_ip4_routes_from_variant (GPtrArray of NMIPRoute objects. -Parameters +Parameters @@ -1127,7 +1127,7 @@ and metric) into a GPtrArray of -Returns +Returns a newly allocated GPtrArray of NMIPRoute objects. [transfer full][element-type NMIPRoute] @@ -1139,7 +1139,7 @@ and metric) into a GPtrArray of guint32 nm_utils_ip4_netmask_to_prefix (guint32 netmask); -Parameters +Parameters @@ -1154,7 +1154,7 @@ nm_utils_ip4_netmask_to_prefix (g -Returns +Returns the CIDR prefix represented by the netmask @@ -1164,7 +1164,7 @@ nm_utils_ip4_netmask_to_prefix (g guint32 nm_utils_ip4_prefix_to_netmask (guint32 prefix); -Parameters +Parameters @@ -1179,7 +1179,7 @@ nm_utils_ip4_prefix_to_netmask (g -Returns +Returns the netmask represented by the prefix, in network byte order @@ -1193,7 +1193,7 @@ 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 falls in the predefined classes. -Parameters +Parameters @@ -1208,7 +1208,7 @@ falls in the predefined classes. -Returns +Returns the default class prefix for the given IP @@ -1220,7 +1220,7 @@ nm_utils_ip6_dns_to_variant (char Utility function to convert an array of IP address strings int a GVariant of type 'aay' representing an array of IPv6 addresses. -Parameters +Parameters @@ -1235,7 +1235,7 @@ type 'aay' representing an array of IPv6 addresses. -Returns +Returns a new floating GVariant representing dns . [transfer none] @@ -1249,7 +1249,7 @@ nm_utils_ip6_dns_from_variant (GV Utility function to convert a GVariant of type 'aay' representing a list of IPv6 addresses into an array of IP address strings. -Parameters +Parameters @@ -1264,7 +1264,7 @@ IPv6 addresses into an array of IP address strings. -Returns +Returns a NULL-terminated array of IP address strings. [transfer full][type utf8] @@ -1283,7 +1283,7 @@ gateway). The "gateway" field of the first address will get the value of (if non-NULL). In all of the other addresses, that field will be all 0s. -Parameters +Parameters @@ -1305,7 +1305,7 @@ all 0s. -Returns +Returns a new floating GVariant representing addresses . [transfer none] @@ -1324,7 +1324,7 @@ of the first address (if set) will be returned in ou ; the "gateway" fields of the other addresses are ignored. -Parameters +Parameters @@ -1346,7 +1346,7 @@ fields of the other addresses are ignored. -Returns +Returns a newly allocated GPtrArray of NMIPAddress objects. [transfer full][element-type NMIPAddress] @@ -1362,7 +1362,7 @@ IPv6 routes into a GVariant of type 'a(ayuayu)' repres NetworkManager IPv6 routes (which are tuples of route, prefix, next hop, and metric). -Parameters +Parameters @@ -1377,7 +1377,7 @@ metric). -Returns +Returns a new floating GVariant representing routes . [transfer none] @@ -1392,7 +1392,7 @@ nm_utils_ip6_routes_from_variant (GPtrArray of NMIPRoute objects. -Parameters +Parameters @@ -1407,7 +1407,7 @@ hop, and metric) into a GPtrArray of -Returns +Returns a newly allocated GPtrArray of NMIPRoute objects. [transfer full][element-type NMIPRoute] @@ -1424,7 +1424,7 @@ array of new-style NetworkManager IP addresses. All addresses will include "address" (an IP address string), and "prefix" (a uint). Some addresses may include additional attributes. -Parameters +Parameters @@ -1439,7 +1439,7 @@ include additional attributes. -Returns +Returns a new floating GVariant representing addresses . [transfer none] @@ -1456,7 +1456,7 @@ NetworkManager IPv4 or IPv6 addresses (as described in the documentation for nm_utils_ip_addresses_to_variant()) into a GPtrArray of NMIPAddress objects. -Parameters +Parameters @@ -1478,7 +1478,7 @@ objects. -Returns +Returns a newly allocated GPtrArray of NMIPAddress objects. [transfer full][element-type NMIPAddress] @@ -1494,7 +1494,7 @@ IPv4 or IPv6 routes into a GVariant of type 'aa{sv}' r of new-style NetworkManager IP routes (which are tuples of destination, prefix, next hop, metric, and additional attributes). -Parameters +Parameters @@ -1509,7 +1509,7 @@ prefix, next hop, metric, and additional attributes). -Returns +Returns a new floating GVariant representing routes . [transfer none] @@ -1526,7 +1526,7 @@ NetworkManager IPv4 or IPv6 addresses (which are tuples of destination, prefix, next hop, metric, and additional attributes) into a GPtrArray of NMIPRoute objects. -Parameters +Parameters @@ -1548,7 +1548,7 @@ prefix, next hop, metric, and additional attributes) into a G -Returns +Returns a newly allocated GPtrArray of NMIPRoute objects. [transfer full][element-type NMIPRoute] @@ -1560,7 +1560,7 @@ prefix, next hop, metric, and additional attributes) into a G char * nm_utils_uuid_generate (void); -Returns +Returns a newly allocated UUID suitable for use as the NMSettingConnection object's “id”: property. Should be freed with g_free() @@ -1575,7 +1575,7 @@ nm_utils_file_is_certificate (const -Parameters +Parameters @@ -1590,7 +1590,7 @@ recognized by NetworkManager. -Returns +Returns TRUE if the file is a certificate, FALSE if it is not @@ -1605,7 +1605,7 @@ nm_utils_file_is_private_key (const -Parameters +Parameters @@ -1627,7 +1627,7 @@ recognized by NetworkManager. -Returns +Returns TRUE if the file is a private key, FALSE if it is not @@ -1639,7 +1639,7 @@ nm_utils_file_is_pkcs12 (const ch Tests if filename is a PKCS#12 file. -Parameters +Parameters @@ -1654,7 +1654,7 @@ nm_utils_file_is_pkcs12 (const ch -Returns +Returns TRUE if the file is PKCS#12, FALSE if it is not @@ -1689,7 +1689,7 @@ nm_utils_file_search_in_paths (const paths . -Parameters +Parameters @@ -1748,7 +1748,7 @@ function. -Returns +Returns 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. @@ -1762,7 +1762,7 @@ invocations of the function might overwrite it. nm_utils_wifi_freq_to_channel (guint32 freq); Utility function to translate a Wi-Fi frequency to its corresponding channel. -Parameters +Parameters @@ -1777,7 +1777,7 @@ nm_utils_wifi_freq_to_channel (gu -Returns +Returns the channel represented by the frequency or 0 @@ -1789,7 +1789,7 @@ nm_utils_wifi_channel_to_freq (gu const char *band); Utility function to translate a Wi-Fi channel to its corresponding frequency. -Parameters +Parameters @@ -1811,7 +1811,7 @@ nm_utils_wifi_channel_to_freq (gu -Returns +Returns the frequency represented by the channel of the band, or -1 when the freq is invalid, or 0 when the band is invalid @@ -1826,7 +1826,7 @@ nm_utils_wifi_find_next_channel ( char *band); Utility function to find out next/previous Wi-Fi channel for a channel. -Parameters +Parameters @@ -1853,7 +1853,7 @@ nm_utils_wifi_find_next_channel ( -Returns +Returns the next channel in the specified direction or 0 @@ -1865,7 +1865,7 @@ nm_utils_wifi_is_channel_valid (g const char *band); Utility function to verify Wi-Fi channel validity. -Parameters +Parameters @@ -1887,7 +1887,7 @@ nm_utils_wifi_is_channel_valid (g -Returns +Returns TRUE or FALSE @@ -1898,7 +1898,7 @@ nm_utils_wifi_is_channel_valid (g nm_utils_wifi_2ghz_freqs (void); Utility function to return 2.4 GHz Wi-Fi frequencies (802.11bg band). -Returns +Returns zero-terminated array of frequencies numbers (in MHz) Since: 1.2 @@ -1910,7 +1910,7 @@ nm_utils_wifi_2ghz_freqs (voidvoid); Utility function to return 5 GHz Wi-Fi frequencies (802.11a band). -Returns +Returns zero-terminated array of frequencies numbers (in MHz) Since: 1.2 @@ -1926,7 +1926,7 @@ strength suitable for printing to stdout. If the current locale and terminal support it, this will use unicode graphics characters to represent "bars". Otherwise it will use 0 to 4 asterisks. -Parameters +Parameters @@ -1941,7 +1941,7 @@ support it, this will use unicode graphics characters to represent -Returns +Returns the graphical representation of the access point strength @@ -1955,7 +1955,7 @@ nm_utils_hwaddr_len (int t It is an error to call this function with any value other than ARPHRD_ETHER or ARPHRD_INFINIBAND. -Parameters +Parameters @@ -1971,7 +1971,7 @@ nm_utils_hwaddr_len (int t -Returns +Returns the length. @@ -1984,7 +1984,7 @@ nm_utils_hwaddr_ntoa (gconstpoint Converts addr to textual form. -Parameters +Parameters @@ -2007,7 +2007,7 @@ nm_utils_hwaddr_ntoa (gconstpoint -Returns +Returns the textual form of addr . [transfer full] @@ -2023,7 +2023,7 @@ nm_utils_hwaddr_atoba (const char and converts it to binary form in a GByteArray. See nm_utils_hwaddr_aton() if you don't want a GByteArray. -Parameters +Parameters @@ -2045,7 +2045,7 @@ nm_utils_hwaddr_atoba (const char -Returns +Returns a new GByteArray, or NULL if asc couldn't be parsed. @@ -2065,7 +2065,7 @@ nm_utils_hwaddr_aton (const char< Bytes in asc can be sepatared by colons (:), or hyphens (-), but not mixed. -Parameters +Parameters @@ -2093,7 +2093,7 @@ the size of the buffer in bytes. -Returns +Returns buffer , or NULL if asc couldn't be parsed @@ -2111,7 +2111,7 @@ nm_utils_hwaddr_valid (const char to see if it is a valid hardware address of the given length. -Parameters +Parameters @@ -2135,7 +2135,7 @@ is expected to convert to -Returns +Returns TRUE if asc appears to be a valid hardware address of the indicated length, FALSE if not. @@ -2152,7 +2152,7 @@ nm_utils_hwaddr_canonical (const length, and if so, returns it in canonical form (uppercase, with leading 0s as needed, and with colons rather than hyphens). -Parameters +Parameters @@ -2176,7 +2176,7 @@ is expected to convert to -Returns +Returns the canonicalized address if asc appears to be a valid hardware address of the indicated length, NULL if not. @@ -2223,7 +2223,7 @@ match. (This means that externally-provided address strings do not need to be sanity-checked before comparing them against known good addresses; they are guaranteed to not match if they are invalid.) -Parameters +Parameters @@ -2259,7 +2259,7 @@ is ASCII -Returns +Returns TRUE if hwaddr1 and hwaddr2 are equivalent, FALSE if they are @@ -2279,7 +2279,7 @@ nm_utils_bin2hexstr (gconstpointe greater than -1, the returned string is terminated at that index (returned_string[final_len] == '\0'), -Parameters +Parameters @@ -2307,7 +2307,7 @@ array -Returns +Returns the textual form of bytes . [transfer full] @@ -2326,7 +2326,7 @@ eg "00:11" or "0:1". Any "0x" at the beginning of h may not start or end with ':'. -Parameters +Parameters @@ -2341,7 +2341,7 @@ may not start or end with ':'. -Returns +Returns the converted bytes, or NULL on error. [transfer full] @@ -2354,7 +2354,7 @@ nm_utils_iface_valid_name (const This function is a 1:1 copy of the kernel's interface validation function in net/core/dev.c. -Parameters +Parameters @@ -2369,7 +2369,7 @@ function in net/core/dev.c. -Returns +Returns TRUE if interface name is valid, otherwise FALSE is returned. @@ -2381,7 +2381,7 @@ nm_utils_is_uuid (const charChecks if str is a UUID -Parameters +Parameters @@ -2396,7 +2396,7 @@ nm_utils_is_uuid (const char -Returns +Returns TRUE if str is a UUID, FALSE if not @@ -2410,7 +2410,7 @@ nm_utils_inet4_ntop (in_addr_tWrapper for inet_ntop. [skip] -Parameters +Parameters @@ -2441,7 +2441,7 @@ buffer to avoid these issues. -Returns +Returns the input buffer dst , or a pointer to an internal, static buffer. This function cannot fail. @@ -2456,7 +2456,7 @@ nm_utils_inet6_ntop (const struct Wrapper for inet_ntop. [skip] -Parameters +Parameters @@ -2487,7 +2487,7 @@ buffer to avoid these issues. -Returns +Returns the input buffer dst , or a pointer to an internal, static buffer. NULL is not allowed as in6addr @@ -2504,7 +2504,7 @@ nm_utils_ipaddr_valid (int Checks if ip contains a valid IP address of the given family. -Parameters +Parameters @@ -2527,7 +2527,7 @@ nm_utils_ipaddr_valid (int -Returns +Returns TRUE or FALSE @@ -2559,7 +2559,7 @@ compatible with virtual_type configuration of the two connections, or on the capabilities of an underlying device driver. -Parameters +Parameters @@ -2582,7 +2582,7 @@ underlying device driver. -Returns +Returns TRUE or FALSE @@ -2597,7 +2597,7 @@ available modes. The mode string can be either a descriptive name or a number (as string). -Parameters +Parameters @@ -2612,7 +2612,7 @@ The mode -Returns +Returns numeric bond mode, or -1 on error Since: 1.2 @@ -2626,7 +2626,7 @@ nm_utils_bond_mode_int_to_string ( -Parameters +Parameters @@ -2641,7 +2641,7 @@ available modes. -Returns +Returns bonding mode string, or NULL on error Since: 1.2 @@ -2657,7 +2657,7 @@ nm_utils_enum_to_str (GTypeG_TYPE_ENUM and the given value is not valid the function returns NULL. -Parameters +Parameters @@ -2679,7 +2679,7 @@ function returns NULL. -Returns +Returns a newly allocated string or NULL Since: 1.2 @@ -2699,7 +2699,7 @@ the function returns FALSE and stores a pointer to containing the unrecognized token in err_token . -Parameters +Parameters @@ -2731,7 +2731,7 @@ containing the unrecognized token in err_token -Returns +Returns TRUE if the conversion was successful, FALSE otherwise Since: 1.2 @@ -2745,7 +2745,7 @@ nm_utils_enum_get_values (GTypegint to); Returns the list of possible values for a given enum. -Parameters +Parameters @@ -2772,7 +2772,7 @@ nm_utils_enum_get_values (GType -Returns +Returns a NULL-terminated dynamically-allocated array of static strings or NULL on error. [transfer full] @@ -2788,7 +2788,7 @@ or NULL on error. Used with nm_utils_security_valid() for checking whether a given access point is compatible with a network device. -Members +Members @@ -2890,6 +2890,6 @@ for both -Generated by GTK-Doc V1.24 +Generated by GTK-Doc V1.25 \ No newline at end of file -- cgit 1.3.0-6-gf8a5