From e152ec7bf4ba252ff9d3eb13eabd417b931dac9a Mon Sep 17 00:00:00 2001
From: Iain Lane
-GQuark
+GQuark
nm_setting_error_quark ()
@@ -51,7 +51,7 @@
-gboolean
+gboolean
(*NMSettingClearSecretsWithFlagsFn) ()
@@ -67,7 +67,7 @@
-GHashTable *
+GHashTable *
nm_setting_to_hash ()
@@ -98,7 +98,7 @@
-gboolean
+gboolean
nm_setting_verify ()
@@ -106,7 +106,7 @@
-gboolean
+gboolean
nm_setting_compare ()
@@ -114,7 +114,7 @@
-gboolean
+gboolean
nm_setting_diff ()
@@ -154,7 +154,7 @@
-GPtrArray *
+GPtrArray *
nm_setting_need_secrets ()
@@ -162,7 +162,7 @@
-gboolean
+gboolean
nm_setting_update_secrets ()
@@ -170,7 +170,7 @@
-gboolean
+gboolean
nm_setting_get_secret_flags ()
@@ -178,7 +178,7 @@
-gboolean
+gboolean
nm_setting_set_secret_flags ()
@@ -204,7 +204,7 @@
@@ -277,7 +277,7 @@
├── NMSettingError
├── NMSettingHashFlags
╰── NMSettingSecretFlags
- GObject
+ GObject
╰── NMSetting
├── NMSetting8021x
├── NMSettingAdsl
@@ -325,7 +325,7 @@ of properties and allowed values.
-gchar *
+gchar *
name
Read / Write
GQuark +GQuark nm_setting_error_quark (void);Registers an error quark for NMSetting if necessary.
@@ -336,11 +336,11 @@ nm_setting_error_quark (voidNMSettingClearSecretsWithFlagsFn ()
-gboolean +gboolean (*NMSettingClearSecretsWithFlagsFn) (+NMSetting *setting,const char *secret,NMSettingSecretFlags flags, -gpointer user_data);gpointer user_data);Parameters
@@ -375,7 +375,7 @@ nm_setting_error_quark (
void
@@ -384,9 +384,9 @@ nm_setting_error_quark (voidvoid (*NMSettingValueIterFn) (NMSetting *setting,const char *key, -const GValue *value, -GParamFlags flags, -gpointer user_data); +const GValue *value, +GParamFlags flags, +gpointer user_data);Parameters
@@ -429,10 +429,10 @@ nm_setting_error_quark (
voidnm_setting_to_hash ()
-GHashTable * +GHashTable * nm_setting_to_hash (-NMSetting *setting,NMSettingHashFlags flags);Converts the NMSetting into a GHashTable mapping each setting property +
Converts the NMSetting into a GHashTable mapping each setting property name to a GValue describing that property, suitable for marshalling over D-Bus or serializing. The mapping is string to GValue.
@@ -459,7 +459,7 @@ D-Bus or serializing. The mapping is string to GValue.@@ -468,8 +468,8 @@ describing the setting's properties.Returns
-a new GHashTable +
a new GHashTable describing the setting's properties.
[transfer full][element-type utf8 GObject.Value]
nm_setting_new_from_hash ()
NMSetting * -nm_setting_new_from_hash (+nm_setting_new_from_hash (GType setting_type, -GHashTable *hash);GType setting_type, +GHashTable *hash);Creates a new NMSetting object and populates that object with the properties contained in the hash table, using each hash key as the property to set, and each hash value as the value to set that property to. Setting properties @@ -492,7 +492,7 @@ property names and value types.
@@ -502,7 +502,7 @@ string to GValue mapping of properties that apply to the setting. - hash
the GHashTable containing a +
the GHashTable containing a string to GValue mapping of properties that apply to the setting.
[element-type utf8 GObject.Value]
@@ -563,14 +563,14 @@ like 'ppp' or 'wireless' or 'wired'.
nm_setting_verify ()
-gboolean +gboolean nm_setting_verify (+NMSetting *setting, -GSList *all_settings, -GError **error);GSList *all_settings, +GError **error);Validates the setting. Each setting's properties have allowed values, and some are dependent on other values (hence the need for
all_settings). 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
@@ -588,14 +588,14 @@ failed validation, and in what way that property failed validation.- all_settings
a GSList of all settings +
a GSList of all settings in the connection from which
settingcame.[element-type NMSetting] @@ -603,13 +603,13 @@ came. - error
+ location to store error, or
NULLlocation to store error, or
NULL
nm_setting_compare ()
-gboolean +gboolean nm_setting_compare (@@ -645,18 +645,18 @@ for a description of each flag's behavior.NMSetting *a,NMSetting *b,NMSettingCompareFlags flags);
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 @@ -690,7 +690,7 @@ one or more
invert_results
+be set to this parameter is used internally by libnm-util and should -be set to
FALSE. IfTRUEinverts the meaning of the NMSettingDiffResult.FALSE. IfTRUEinverts the meaning of the NMSettingDiffResult.@@ -707,7 +707,7 @@ in and the settings differ, a new one is created and returned. Returns
-+
TRUEif the settings contain the same values,FALSEif they do not
TRUEif the settings contain the same values,FALSEif they do not
@@ -716,7 +716,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.
@@ -775,7 +775,7 @@ output format is not guaranteed to be stable and may change at any time.Returns
an allocated string containing a textual representation of the setting's properties and values (including secrets!), which the caller should -free with
+free withg_free()g_free()
@@ -808,7 +808,7 @@ leakage of information.void nm_setting_clear_secrets_with_flags (+NMSetting *setting,NMSettingClearSecretsWithFlagsFn func, -gpointer user_data);gpointer user_data);Clears and frees secrets determined by
func.@@ -844,7 +844,7 @@ specific secret should be cleared or not.
nm_setting_need_secrets ()
-GPtrArray * +GPtrArray * nm_setting_need_secrets (NMSetting *setting);Returns an array of property names for each secret which may be required to make a successful connection. The returned hints are only intended as a @@ -867,9 +867,9 @@ is no way to conclusively determine exactly which secrets are needed.
@@ -877,10 +877,10 @@ free the elements.Returns
-a GPtrArray containing +
a GPtrArray containing the property names of secrets of the NMSetting which may be required; the -caller owns the array and must free it with
g_ptr_array_free(), but must not +caller owns the array and must free it withg_ptr_array_free(), but must not free the elements.[transfer container][element-type utf8]
nm_setting_update_secrets ()
-gboolean +gboolean nm_setting_update_secrets (+NMSetting *setting, -GHashTable *secrets, -GError **error);GHashTable *secrets, +GError **error);Update the setting's secrets, given a hash table of secrets intended for that setting (deserialized from D-Bus for example).
@@ -899,13 +899,13 @@ setting (deserialized from D-Bus for example).- secrets
+ a GHashTable mapping -string to GValue of setting property names and secrets.
a GHashTable mapping +string to GValue of setting property names and secrets.
[element-type utf8 GObject.Value] @@ -913,18 +913,18 @@ string to - error
+ location to store error, or
NULLlocation to store error, or
NULLReturns
-
TRUEif the secrets were successfully updated,FALSEon failure to +
TRUEif the secrets were successfully updated,FALSEon failure to update one or more of the secrets.
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.
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.
@@ -1037,7 +1037,7 @@ needs to use if specified in the settings.@@ -1389,7 +1389,7 @@ if you specifyReturns
-Name of the virtual interface or
NULLif the setting does not +Name of the virtual interface or
NULLif the setting does not support this featureNM_SETTING_COMPARE_FLAG_DIFF_RESULT_WProperty Details
+The
-“name”property“name” gchar *+“name” gchar *The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".
@@ -1399,6 +1399,6 @@ example "ppp" or "wireless" or "wired".
Generated by GTK-Doc V1.28