From 681dfc70ef98f6ed0c05bcb0fbff00e3fc0799ea Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Mon, 26 Aug 2024 16:10:34 +0200 Subject: New upstream version 1.48.10 --- docs/libnm/html/NMSetting.html | 180 ++++++++++++++++++++--------------------- 1 file changed, 90 insertions(+), 90 deletions(-) (limited to 'docs/libnm/html/NMSetting.html') diff --git a/docs/libnm/html/NMSetting.html b/docs/libnm/html/NMSetting.html index 662a8fd1..a6925d42 100644 --- a/docs/libnm/html/NMSetting.html +++ b/docs/libnm/html/NMSetting.html @@ -8,7 +8,7 @@ - + @@ -42,7 +42,7 @@ -gboolean +gboolean (*NMSettingClearSecretsWithFlagsFn) () @@ -58,7 +58,7 @@ -GType +GType nm_setting_lookup_type () @@ -81,7 +81,7 @@ -gboolean +gboolean nm_setting_verify () @@ -89,7 +89,7 @@ -gboolean +gboolean nm_setting_verify_secrets () @@ -97,7 +97,7 @@ -gboolean +gboolean nm_setting_compare () @@ -105,7 +105,7 @@ -gboolean +gboolean nm_setting_diff () @@ -129,7 +129,7 @@ -gboolean +gboolean nm_setting_get_secret_flags () @@ -137,7 +137,7 @@ -gboolean +gboolean nm_setting_set_secret_flags () @@ -145,7 +145,7 @@ -GVariant * +GVariant * nm_setting_option_get () @@ -153,7 +153,7 @@ -gboolean +gboolean nm_setting_option_get_boolean () @@ -161,7 +161,7 @@ -gboolean +gboolean nm_setting_option_get_uint32 () @@ -207,7 +207,7 @@ -const GVariantType * +const GVariantType * nm_setting_get_dbus_property_type () @@ -215,7 +215,7 @@ -GType +GType nm_setting_get_enum_property_type () @@ -255,7 +255,7 @@ -gboolean +gboolean nm_range_get_range () @@ -348,11 +348,11 @@ of properties and allowed values.

Functions

NMSettingClearSecretsWithFlagsFn ()

-
gboolean
+
gboolean
 (*NMSettingClearSecretsWithFlagsFn) (NMSetting *setting,
                                      const char *secret,
                                      NMSettingSecretFlags flags,
-                                     gpointer user_data);
+ gpointer user_data);

Parameters

@@ -387,7 +387,7 @@ of properties and allowed values.

Returns

-

TRUE to clear the secret, FALSE to not clear the secret

+

TRUE to clear the secret, FALSE to not clear the secret


@@ -396,9 +396,9 @@ of properties and allowed values.

void
 (*NMSettingValueIterFn) (NMSetting *setting,
                          const char *key,
-                         const GValue *value,
-                         GParamFlags flags,
-                         gpointer user_data);
+ const GValue *value, + GParamFlags flags, + gpointer user_data);

Parameters

@@ -441,9 +441,9 @@ of properties and allowed values.


nm_setting_lookup_type ()

-
GType
+
GType
 nm_setting_lookup_type (const char *name);
-

Returns the GType of the setting's class for a given setting name.

+

Returns the GType of the setting's class for a given setting name.

Parameters

@@ -461,7 +461,7 @@ nm_setting_lookup_type (const cha

Returns

-

the GType of the setting's class, or G_TYPE_INVALID if +

the GType of the setting's class, or G_TYPE_INVALID if name is not recognized.

@@ -524,14 +524,14 @@ like 'ppp' or 'wireless' or 'wired'.


nm_setting_verify ()

-
gboolean
+
gboolean
 nm_setting_verify (NMSetting *setting,
                    NMConnection *connection,
-                   GError **error);
+ GError **error);

Validates the setting. Each setting's properties have allowed values, and some are dependent on other values (hence the need for connection ). The -returned GError contains information about which property of the setting +returned GError contains information about which property of the setting failed validation, and in what way that property failed validation.

Parameters

@@ -551,13 +551,13 @@ failed validation, and in what way that property failed validation.

- + @@ -565,18 +565,18 @@ is being verified in isolation.

Returns

-

TRUE if the setting is valid, FALSE if it is not

+

TRUE if the setting is valid, FALSE if it is not


nm_setting_verify_secrets ()

-
gboolean
+
gboolean
 nm_setting_verify_secrets (NMSetting *setting,
                            NMConnection *connection,
-                           GError **error);
+ GError **error);

Verifies the secrets in the setting. -The returned GError contains information about which secret of the setting +The returned GError contains information about which secret of the setting failed validation, and in what way that secret failed validation. The secret validation is done separately from main setting validation, because in some cases connection failure is not desired just for the secrets.

@@ -598,13 +598,13 @@ in some cases connection failure is not desired just for the secrets.

- + @@ -612,14 +612,14 @@ is being verified in isolation.

Returns

-

TRUE if the setting secrets are valid, FALSE if they are not

+

TRUE if the setting secrets are valid, FALSE if they are not

Since: 1.2


nm_setting_compare ()

-
gboolean
+
gboolean
 nm_setting_compare (NMSetting *a,
                     NMSetting *b,
                     NMSettingCompareFlags flags);
@@ -655,18 +655,18 @@ for a description of each flag's behavior.

Returns

-

TRUE if the comparison succeeds, FALSE if it does not

+

TRUE if the comparison succeeds, FALSE if it does not


nm_setting_diff ()

-
gboolean
+
gboolean
 nm_setting_diff (NMSetting *a,
                  NMSetting *b,
                  NMSettingCompareFlags flags,
-                 gboolean invert_results,
-                 GHashTable **results);
+ gboolean invert_results, + GHashTable **results);

Compares two NMSetting objects for similarity, with comparison behavior modified by a set of flags. See the documentation for NMSettingCompareFlags for a description of each flag's behavior. If the settings differ, the keys @@ -700,7 +700,7 @@ one or more

invert_results

+be set to FALSE. If TRUE inverts the meaning of the NMSettingDiffResult.

@@ -717,7 +717,7 @@ in and the settings differ, a new one is created and returned.

Returns

-

TRUE if the settings contain the same values, FALSE if they do not

+

TRUE if the settings contain the same values, FALSE if they do not


@@ -726,7 +726,7 @@ in and the settings differ, a new one is created and returned.

void
 nm_setting_enumerate_values (NMSetting *setting,
                              NMSettingValueIterFn func,
-                             gpointer user_data);
+ gpointer user_data);

Iterates over each property of the NMSetting object, calling the supplied user function for each property.

@@ -786,17 +786,17 @@ be stable and may change at any time.

Returns

an allocated string containing a textual representation of the setting's properties and values, which the caller should -free with g_free()

+free with g_free()


nm_setting_get_secret_flags ()

-
gboolean
+
gboolean
 nm_setting_get_secret_flags (NMSetting *setting,
                              const char *secret_name,
                              NMSettingSecretFlags *out_flags,
-                             GError **error);
+ GError **error);

For a given secret, retrieves the NMSettingSecretFlags describing how to handle that secret.

@@ -825,7 +825,7 @@ handle that secret.

- + @@ -833,18 +833,18 @@ handle that secret.

Returns

-

TRUE on success (if the given secret name was a valid property of -this setting, and if that property is secret), FALSE if not

+

TRUE on success (if the given secret name was a valid property of +this setting, and if that property is secret), FALSE if not


nm_setting_set_secret_flags ()

-
gboolean
+
gboolean
 nm_setting_set_secret_flags (NMSetting *setting,
                              const char *secret_name,
                              NMSettingSecretFlags flags,
-                             GError **error);
+ GError **error);

For a given secret, stores the NMSettingSecretFlags describing how to handle that secret.

@@ -873,7 +873,7 @@ handle that secret.

- + @@ -881,14 +881,14 @@ handle that secret.

Returns

-

TRUE on success (if the given secret name was a valid property of -this setting, and if that property is secret), FALSE if not

+

TRUE on success (if the given secret name was a valid property of +this setting, and if that property is secret), FALSE if not


nm_setting_option_get ()

-
GVariant *
+
GVariant *
 nm_setting_option_get (NMSetting *setting,
                        const char *opt_name);
@@ -915,7 +915,7 @@ nm_setting_option_get (

Returns

-

the GVariant or NULL if the option +

the GVariant or NULL if the option is not set.

[transfer none]

@@ -924,10 +924,10 @@ is not set.


nm_setting_option_get_boolean ()

-
gboolean
+
gboolean
 nm_setting_option_get_boolean (NMSetting *setting,
                                const char *opt_name,
-                               gboolean *out_value);
+ gboolean *out_value);

Parameters

connection

the NMConnection that setting came from, or -NULL if setting +NULL if setting is being verified in isolation.

[nullable]

error

location to store error, or NULL

location to store error, or NULL

 

connection

the NMConnection that setting came from, or -NULL if setting +NULL if setting is being verified in isolation.

[nullable]

error

location to store error, or NULL

location to store error, or NULL

 

this parameter is used internally by libnm and should -be set to FALSE. If TRUE inverts the meaning of the NMSettingDiffResult.

 

error

location to store error, or NULL

location to store error, or NULL

 

error

location to store error, or NULL

location to store error, or NULL

 
@@ -950,7 +950,7 @@ nm_setting_option_get_boolean ( +If the option is unset, FALSE will be returned.

@@ -958,7 +958,7 @@ If the option is unset, FALSE will be returned.

Returns

-

TRUE if opt_name +

TRUE if opt_name is set to a boolean variant.

Since: 1.26

@@ -966,10 +966,10 @@ is set to a boolean variant.


nm_setting_option_get_uint32 ()

-
gboolean
+
gboolean
 nm_setting_option_get_uint32 (NMSetting *setting,
                               const char *opt_name,
-                              guint32 *out_value);
+ guint32 *out_value);

Parameters

out_value

the optional output value. -If the option is unset, FALSE will be returned.

[out][nullable]
@@ -1000,7 +1000,7 @@ If the option is unset, 0 will be returned.

Returns

-

TRUE if opt_name +

TRUE if opt_name is set to a uint32 variant.

Since: 1.26

@@ -1011,9 +1011,9 @@ is set to a uint32 variant.

void
 nm_setting_option_set (NMSetting *setting,
                        const char *opt_name,
-                       GVariant *variant);
+ GVariant *variant);

If variant - is NULL, this clears the option if it is set. + is NULL, this clears the option if it is set. Otherwise, variant is set as the option. If variant is @@ -1056,7 +1056,7 @@ Currently, only void nm_setting_option_set_uint32 (NMSetting *setting, const char *opt_name, - guint32 value); + guint32 value);

Like nm_setting_option_set() to set a uint32 GVariant.

Parameters

@@ -1088,7 +1088,7 @@ nm_setting_option_set_uint32 (void nm_setting_option_set_boolean (NMSetting *setting, const char *opt_name, - gboolean value); + gboolean value);

Like nm_setting_option_set() to set a boolean GVariant.

Parameters

@@ -1119,7 +1119,7 @@ nm_setting_option_set_boolean (

nm_setting_option_get_all_names ()

const char *const *
 nm_setting_option_get_all_names (NMSetting *setting,
-                                 guint *out_len);
+ guint *out_len);

Gives the name of all set options.

Parameters

@@ -1145,8 +1145,8 @@ nm_setting_option_get_all_names (

Returns

-

A NULL terminated array of key names. If no names are present, this returns -NULL. The returned array and the names are owned by NMSetting and might be invalidated +

A NULL terminated array of key names. If no names are present, this returns +NULL. The returned array and the names are owned by NMSetting and might be invalidated by the next operation.

[array length=out_len zero-terminated=1][transfer none][nullable]

@@ -1176,8 +1176,8 @@ nm_setting_option_clear_by_name (

predicate

+If the predicate returns TRUE for an option name, the option +gets removed. If NULL, all options will be removed.

@@ -1188,12 +1188,12 @@ gets removed. If NULL, all options will be removed.

nm_setting_get_dbus_property_type ()

-
const GVariantType *
+
const GVariantType *
 nm_setting_get_dbus_property_type (NMSetting *setting,
                                    const char *property_name);

Gets the D-Bus marshalling type of a property. property_name is a D-Bus -property name, which may not necessarily be a GObject property.

+property name, which may not necessarily be a GObject property.

Parameters

the predicate for which names should be clear. -If the predicate returns TRUE for an option name, the option -gets removed. If NULL, all options will be removed.

[nullable][scope call]
@@ -1227,15 +1227,15 @@ on setting

nm_setting_get_enum_property_type ()

-
GType
-nm_setting_get_enum_property_type (GType setting_type,
+
GType
+nm_setting_get_enum_property_type (GType setting_type,
                                    const char *property_name);

Get the type of the enum that defines the values that the property accepts. It is only useful for properties configured to accept values from certain enum type, otherwise -it will return G_TYPE_INVALID. Note that flags (children of G_TYPE_FLAGS) are also +it will return G_TYPE_INVALID. Note that flags (children of G_TYPE_FLAGS) are also considered enums.

Note that the GObject property might be implemented as an integer, actually, and not -as enum. Find out what underlying type is used, checking the GParamSpec, before +as enum. Find out what underlying type is used, checking the GParamSpec, before setting the GObject property.

Parameters

@@ -1261,7 +1261,7 @@ setting the GObject property.

Returns

-

the enum's GType, or G_TYPE_INVALID if the property is not of enum type

+

the enum's GType, or G_TYPE_INVALID if the property is not of enum type

Since: 1.46

@@ -1269,8 +1269,8 @@ setting the GObject property.

nm_range_new ()

NMRange *
-nm_range_new (guint64 start,
-              guint64 end);
+nm_range_new (guint64 start, + guint64 end);

Creates a new NMRange object for the given range. Setting end equal to start @@ -1400,10 +1400,10 @@ over the ranges.


nm_range_get_range ()

-
gboolean
+
gboolean
 nm_range_get_range (const NMRange *range,
-                    guint64 *start,
-                    guint64 *end);
+ guint64 *start, + guint64 *end);

Gets the start and end values for the range.

Parameters

@@ -1434,8 +1434,8 @@ nm_range_get_range (const

Returns

-

TRUE if the range contains more than one -element, FALSE otherwise.

+

TRUE if the range contains more than one +element, FALSE otherwise.

Since: 1.42

@@ -1472,7 +1472,7 @@ nm_range_to_str (const

nm_range_from_str ()

NMRange *
 nm_range_from_str (const char *str,
-                   GError **error);
+ GError **error);

Parses the string representation of the range to create a NMRange instance.

@@ -1499,7 +1499,7 @@ instance.

Returns

-

the NMRange or NULL.

+

the NMRange or NULL.

[transfer full]

Since: 1.42

@@ -1790,6 +1790,6 @@ if you specify NM_SETTING_COMPARE_FLAG_DIFF_RESULT_W
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file -- cgit 1.3.0-6-gf8a5