From 81836c2d44802b4cca833d7775dd627e0797a7e2 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 28 Aug 2015 01:13:48 +0200 Subject: Imported Upstream version 1.0.6 --- docs/libnm/html/libnm-nm-utils.html | 208 ++++++++++++++++++++++++++++++------ 1 file changed, 176 insertions(+), 32 deletions(-) (limited to 'docs/libnm/html/libnm-nm-utils.html') diff --git a/docs/libnm/html/libnm-nm-utils.html b/docs/libnm/html/libnm-nm-utils.html index d3789e5b..5406f966 100644 --- a/docs/libnm/html/libnm-nm-utils.html +++ b/docs/libnm/html/libnm-nm-utils.html @@ -335,6 +335,20 @@ +const guint * + + +nm_utils_wifi_2ghz_freqs () + + + +const guint * + + +nm_utils_wifi_5ghz_freqs () + + + const char * @@ -459,6 +473,22 @@ nm_utils_check_virtual_device_compatibility () + + +char * + + +nm_utils_enum_to_str () + + + + +gboolean + + +nm_utils_enum_from_str () + + @@ -1820,6 +1850,30 @@ nm_utils_wifi_is_channel_valid (g
+

nm_utils_wifi_2ghz_freqs ()

+
const guint *
+nm_utils_wifi_2ghz_freqs (void);
+

Utility function to return 2.4 GHz Wi-Fi frequencies (802.11bg band).

+
+

Returns

+

zero-terminated array of frequencies numbers (in MHz)

+
+

Since: 1.0.6

+
+
+
+

nm_utils_wifi_5ghz_freqs ()

+
const guint *
+nm_utils_wifi_5ghz_freqs (void);
+

Utility function to return 5 GHz Wi-Fi frequencies (802.11a band).

+
+

Returns

+

zero-terminated array of frequencies numbers (in MHz)

+
+

Since: 1.0.6

+
+
+

nm_utils_wifi_strength_bars ()

const char *
 nm_utils_wifi_strength_bars (guint8 strength);
@@ -1829,7 +1883,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

@@ -1844,7 +1898,7 @@ support it, this will use unicode graphics characters to represent
-

Returns

+

Returns

the graphical representation of the access point strength

@@ -1858,7 +1912,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

@@ -1874,7 +1928,7 @@ nm_utils_hwaddr_len (int t
-

Returns

+

Returns

the length.

@@ -1887,7 +1941,7 @@ nm_utils_hwaddr_ntoa (gconstpoint

Converts addr to textual form.

-

Parameters

+

Parameters

@@ -1910,7 +1964,7 @@ nm_utils_hwaddr_ntoa (gconstpoint
-

Returns

+

Returns

the textual form of addr .

[transfer full]

@@ -1926,7 +1980,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

@@ -1948,7 +2002,7 @@ nm_utils_hwaddr_atoba (const char
-

Returns

+

Returns

a new GByteArray, or NULL if asc couldn't be parsed.

@@ -1968,7 +2022,7 @@ nm_utils_hwaddr_aton (const char< Bytes in asc can be sepatared by colons (:), or hyphens (-), but not mixed.

-

Parameters

+

Parameters

@@ -1996,7 +2050,7 @@ the size of the buffer in bytes.

-

Returns

+

Returns

buffer , or NULL if asc couldn't be parsed @@ -2014,7 +2068,7 @@ nm_utils_hwaddr_valid (const char to see if it is a valid hardware address of the given length.

-

Parameters

+

Parameters

@@ -2038,7 +2092,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.

@@ -2055,7 +2109,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

@@ -2079,7 +2133,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.

@@ -2126,7 +2180,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

@@ -2162,7 +2216,7 @@ is ASCII

-

Returns

+

Returns

TRUE if hwaddr1 and hwaddr2 are equivalent, FALSE if they are @@ -2182,7 +2236,7 @@ nm_utils_bin2hexstr (gconstpointe greater than -1, the returned string is terminated at that index (returned_string[final_len] == '\0'),

-

Parameters

+

Parameters

@@ -2210,7 +2264,7 @@ array

-

Returns

+

Returns

the textual form of bytes .

[transfer full]

@@ -2229,7 +2283,7 @@ eg "00:11" or "0:1". Any "0x" at the beginning of h may not start or end with ':'.

-

Parameters

+

Parameters

@@ -2244,7 +2298,7 @@ may not start or end with ':'.

-

Returns

+

Returns

the converted bytes, or NULL on error.

[transfer full]

@@ -2257,7 +2311,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

@@ -2272,7 +2326,7 @@ function in net/core/dev.c.

-

Returns

+

Returns

TRUE if interface name is valid, otherwise FALSE is returned.

@@ -2284,7 +2338,7 @@ nm_utils_is_uuid (const charChecks if str is a UUID

-

Parameters

+

Parameters

@@ -2299,7 +2353,7 @@ nm_utils_is_uuid (const char
-

Returns

+

Returns

TRUE if str is a UUID, FALSE if not

@@ -2313,7 +2367,7 @@ nm_utils_inet4_ntop (in_addr_tWrapper for inet_ntop.

[skip]

-

Parameters

+

Parameters

@@ -2344,7 +2398,7 @@ buffer to avoid these issues.

-

Returns

+

Returns

the input buffer dst , or a pointer to an internal, static buffer. This function cannot fail.

@@ -2359,7 +2413,7 @@ nm_utils_inet6_ntop (const struct

Wrapper for inet_ntop.

[skip]

-

Parameters

+

Parameters

@@ -2390,7 +2444,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 @@ -2407,7 +2461,7 @@ nm_utils_ipaddr_valid (int

Checks if ip contains a valid IP address of the given family.

-

Parameters

+

Parameters

@@ -2430,7 +2484,7 @@ nm_utils_ipaddr_valid (int
-

Returns

+

Returns

TRUE or FALSE

@@ -2462,7 +2516,7 @@ compatible with virtual_type configuration of the two connections, or on the capabilities of an underlying device driver.

-

Parameters

+

Parameters

@@ -2485,10 +2539,100 @@ underlying device driver.

-

Returns

+

Returns

TRUE or FALSE

+
+
+

nm_utils_enum_to_str ()

+
char *
+nm_utils_enum_to_str (GType type,
+                      int value);
+

Converts an enum value to its string representation. If the enum is a +G_TYPE_FLAGS the function returns a comma-separated list of matching values. +If the enum is a G_TYPE_ENUM and the given value is not valid the +function returns NULL.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

type

the GType of the enum

 

value

the value to be translated

 
+
+
+

Returns

+

a newly allocated string or NULL

+
+

Since: 1.0.6

+
+
+
+

nm_utils_enum_from_str ()

+
gboolean
+nm_utils_enum_from_str (GType type,
+                        const char *str,
+                        int *out_value,
+                        char **err_token);
+

Converts a string to the matching enum value.

+

If the enum is a G_TYPE_FLAGS the function returns the logical OR of values +matching the comma-separated tokens in the string; if an unknown token is found +the function returns FALSE and stores a pointer to a newly allocated string +containing the unrecognized token in err_token +.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

type

the GType of the enum

 

str

the input string

 

out_value

(out) (allow-none) the output value

 

err_token

(out) (allow-none) location to store the first unrecognized token

 
+
+
+

Returns

+

TRUE if the conversion was successful, FALSE otherwise

+
+

Since: 1.0.6

+

Types and Values

-- cgit 1.3.0-6-gf8a5