From 494f296a3baab08522617b24b1f126d8f9a17502 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Wed, 20 Jan 2016 16:26:51 +0100 Subject: Imported Upstream version 1.1.90 --- docs/libnm/html/libnm-nm-utils.html | 265 ++++++++++++++++++++++++++++-------- 1 file changed, 208 insertions(+), 57 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 123ff21a..864e8463 100644 --- a/docs/libnm/html/libnm-nm-utils.html +++ b/docs/libnm/html/libnm-nm-utils.html @@ -296,6 +296,14 @@ + +gboolean + + +(*NMUtilsCheckFilePredicate) () + + + const char * @@ -475,6 +483,21 @@ +int + + +nm_utils_bond_mode_string_to_int () + + + +const char * + + +nm_utils_bond_mode_int_to_string () + + + + char * @@ -489,6 +512,13 @@ nm_utils_enum_from_str () + +const char ** + + +nm_utils_enum_get_values () + + @@ -512,12 +542,16 @@ #define NM_UTILS_INET_ADDRSTRLEN + +struct +stat +

Object Hierarchy

-
    GEnum
+
    GEnum
     ╰── NMUtilsSecurityType
@@ -1633,6 +1667,15 @@ nm_utils_file_is_pkcs12 (const ch
+

NMUtilsCheckFilePredicate ()

+
gboolean
+(*NMUtilsCheckFilePredicate) (const char *filename,
+                              const struct stat *stat,
+                              gpointer user_data,
+                              GError **error);
+
+
+

nm_utils_file_search_in_paths ()

const char *
 nm_utils_file_search_in_paths (const char *progname,
@@ -1646,7 +1689,7 @@ nm_utils_file_search_in_paths (const paths
 .

 

-
Parameters

+
Parameters

 
@@ -1705,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. 

@@ -1719,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

@@ -1734,7 +1777,7 @@ nm_utils_wifi_freq_to_channel (gu
-

Returns

+

Returns

the channel represented by the frequency or 0

@@ -1746,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

@@ -1768,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

@@ -1783,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

@@ -1810,7 +1853,7 @@ nm_utils_wifi_find_next_channel (
-

Returns

+

Returns

the next channel in the specified direction or 0

@@ -1822,7 +1865,7 @@ nm_utils_wifi_is_channel_valid (g const char *band);

Utility function to verify Wi-Fi channel validity.

-

Parameters

+

Parameters

@@ -1844,7 +1887,7 @@ nm_utils_wifi_is_channel_valid (g
-

Returns

+

Returns

TRUE or FALSE

@@ -1855,10 +1898,10 @@ 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.0.6

+

Since: 1.2

@@ -1867,10 +1910,10 @@ 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.0.6

+

Since: 1.2

@@ -1883,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

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

Returns

+

Returns

the graphical representation of the access point strength

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

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

Returns

+

Returns

the length.

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

Converts addr to textual form.

-

Parameters

+

Parameters

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

Returns

+

Returns

the textual form of addr .

[transfer full]

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

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

Returns

+

Returns

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

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

-

Parameters

+

Parameters

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

-

Returns

+

Returns

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

-

Parameters

+

Parameters

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

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

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

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

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

-

Returns

+

Returns

TRUE if hwaddr1 and hwaddr2 are equivalent, FALSE if they are @@ -2236,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

@@ -2264,7 +2307,7 @@ array

-

Returns

+

Returns

the textual form of bytes .

[transfer full]

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

-

Parameters

+

Parameters

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

-

Returns

+

Returns

the converted bytes, or NULL on error.

[transfer full]

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

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

-

Returns

+

Returns

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

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

-

Parameters

+

Parameters

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

Returns

+

Returns

TRUE if str is a UUID, FALSE if not

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

[skip]

-

Parameters

+

Parameters

@@ -2398,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.

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

Wrapper for inet_ntop.

[skip]

-

Parameters

+

Parameters

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

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

-

Parameters

+

Parameters

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

Returns

+

Returns

TRUE or FALSE

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

-

Parameters

+

Parameters

@@ -2539,12 +2582,72 @@ underlying device driver.

-

Returns

+

Returns

TRUE or FALSE

+

nm_utils_bond_mode_string_to_int ()

+
int
+nm_utils_bond_mode_string_to_int (const char *mode);
+

Convert bonding mode from string representation to numeric value. +See https://www.kernel.org/doc/Documentation/networking/bonding.txt for +available modes. +The mode + string can be either a descriptive name or a number (as string).

+
+

Parameters

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

mode

bonding mode as string

 
+
+
+

Returns

+

numeric bond mode, or -1 on error

+
+

Since: 1.2

+
+
+
+

nm_utils_bond_mode_int_to_string ()

+
const char *
+nm_utils_bond_mode_int_to_string (int mode);
+

Convert bonding mode from integer value to descriptive name. +See https://www.kernel.org/doc/Documentation/networking/bonding.txt for +available modes.

+
+

Parameters

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

mode

bonding mode as a numeric value

 
+
+
+

Returns

+

bonding mode string, or NULL on error

+
+

Since: 1.2

+
+
+

nm_utils_enum_to_str ()

char *
 nm_utils_enum_to_str (GType type,
@@ -2554,7 +2657,7 @@ nm_utils_enum_to_str (GTypeG_TYPE_ENUM and the given value is not valid the
 function returns NULL.

 

-
Parameters

+
Parameters

 
@@ -2576,10 +2679,10 @@ function returns NULL.

 
 

 

 

 

-
Returns

+
Returns

 
 a newly allocated string or NULL

 

-
Since: 1.0.6

+
Since: 1.2
@@ -2596,7 +2699,7 @@ the function returns FALSE and stores a pointer to containing the unrecognized token in err_token .

-

Parameters

+

Parameters

@@ -2616,22 +2719,65 @@ containing the unrecognized token in err_token - - + + - - + +

out_value

(out) (allow-none) the output value

 

the output value.

[out][allow-none]

err_token

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

 

location to store the first unrecognized token.

[out][allow-none]
-

Returns

+

Returns

TRUE if the conversion was successful, FALSE otherwise

-

Since: 1.0.6

+

Since: 1.2

+
+
+
+

nm_utils_enum_get_values ()

+
const char **
+nm_utils_enum_get_values (GType type,
+                          gint from,
+                          gint to);
+

Returns the list of possible values for a given enum.

+
+

Parameters

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

type

the GType of the enum

 

from

the first element to be returned

 

to

the last element to be returned

 
+
+
+

Returns

+

a NULL-terminated dynamically-allocated array of static strings +or NULL on error.

+

[transfer full]

+
+

Since: 1.2

@@ -2736,6 +2882,11 @@ generating the dynamic WEP keys automatically

argument for both nm_utils_inet4_ntop() and nm_utils_inet6_ntop().

+
+
+

struct stat

+
struct stat;
+
-- cgit 1.3.0-6-gf8a5