NMSetting

@@ -187,7 +187,7 @@ Describes errors that may result from operations involving a

nm_setting_error_quark ()

GQuark              nm_setting_error_quark              (void);

GQuark              nm_setting_error_quark              (void);

Registers an error quark for NMSetting if necessary.

@@ -282,9 +282,9 @@ It should only be accessed through the functions described below.

NMSettingValueIterFn ()

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

+ const GValue *value, + GParamFlags flags, + gpointer user_data);

@@ -321,7 +321,7 @@ It should only be accessed through the functions described below.

nm_setting_get_type ()

GType               nm_setting_get_type                 (void);

GType               nm_setting_get_type                 (void);

@@ -336,9 +336,9 @@ It should only be accessed through the functions described below.

nm_setting_to_hash ()

GHashTable *        nm_setting_to_hash                  (NMSetting *setting);

GHashTable *        nm_setting_to_hash                  (NMSetting *setting);

-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:GValue.

@@ -352,7 +352,7 @@ D-Bus or serializing. The mapping is string:GValue.

- @@ -361,8 +361,8 @@ D-Bus or serializing. The mapping is string:GValue.

nm_setting_new_from_hash ()

NMSetting *         nm_setting_new_from_hash            (GType setting_type,
-                                                         GHashTable *hash);

NMSetting *         nm_setting_new_from_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, @@ -381,7 +381,7 @@ property names and value types.

- @@ -445,13 +445,13 @@ like 'ppp' or 'wireless' or 'wired'.

nm_setting_verify ()

gboolean            nm_setting_verify                   (NMSetting *setting,
-                                                         GSList *all_settings,
-                                                         GError **error);

gboolean            nm_setting_verify                   (NMSetting *setting,
+                                                         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.

Returns :	a new GHashTable describing the setting's properties +	a new GHashTable describing the setting's properties
`hash` :	the GHashTable containing a string:GValue mapping of properties +	the GHashTable containing a string:GValue mapping of properties that apply to the setting

@@ -464,18 +464,18 @@ failed validation, and in what way that property failed validation. - - - @@ -526,7 +526,7 @@ two connections.

nm_setting_compare ()

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

- @@ -565,7 +565,7 @@ for a description of each flag's behavior.

nm_setting_enumerate_values ()

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. @@ -612,7 +612,7 @@ output format is not guaranteed to be stable and may change at any time.

@@ -639,7 +639,7 @@ leakage of information.

nm_setting_need_secrets ()

GPtrArray *         nm_setting_need_secrets             (NMSetting *setting);

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 @@ -656,10 +656,10 @@ is no way to conclusively determine exactly which secrets are needed.

- @@ -668,9 +668,9 @@ itself with

nm_setting_update_secrets ()

gboolean            nm_setting_update_secrets           (NMSetting *setting,
-                                                         GHashTable *secrets,
-                                                         GError **error);

gboolean            nm_setting_update_secrets           (NMSetting *setting,
+                                                         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). @@ -685,19 +685,19 @@ setting (deserialized from D-Bus for example).

- - - @@ -708,7 +708,7 @@ is valid,

Property Details

The `"name"` property

  "name"                     gchar*                : Read / Write

  "name"                     gchar*                : Read / Write

The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for @@ -720,6 +720,6 @@ example 'ppp' or 'wireless' or 'wired'.

+ Generated by GTK-Doc V1.15 \ No newline at end of file -- cgit 1.3.0-6-gf8a5

`all_settings` :	a GSList of all settings in the connection from which `setting` +	a GSList of all settings in the connection from which `setting` came
`error` :	location to store error, or `NULL` +	location to store error, or `NULL`
Returns :	`TRUE` if the setting is valid, `FALSE` if it is not +	`TRUE` if the setting is valid, `FALSE` if it is not
Returns :	`TRUE` if the comparison succeeds, `FALSE` if it does not +	`TRUE` if the comparison succeeds, `FALSE` if it does not
Returns :	an allocated string containing a textual representation of the setting's properties and values (including secrets!), which the caller should -free with `g_free()` +free with `g_free()`
Returns :	a GPtrArray containing the property names of secrets of the +	a GPtrArray containing the property names of secrets of the NMSetting which may be required; the caller owns the array -and must free the each array element with `g_free()`, as well as the array -itself with `g_ptr_array_free()` +and must free the each array element with `g_free()`, as well as the array +itself with `g_ptr_array_free()`
`secrets` :	a GHashTable mapping string:GValue of setting property names and +	a GHashTable mapping string:GValue of setting property names and secrets
`error` :	location to store error, or `NULL` +	location to store error, or `NULL`
Returns :	`TRUE` if the secrets were successfully updated and the connection -is valid, `FALSE` on failure or if the setting was never added to the connection +	`TRUE` if the secrets were successfully updated and the connection +is valid, `FALSE` on failure or if the setting was never added to the connection

Object Hierarchy

Properties

nm_setting_error_quark ()

NMSettingValueIterFn ()

nm_setting_get_type ()

nm_setting_to_hash ()

nm_setting_new_from_hash ()

nm_setting_verify ()

nm_setting_compare ()

nm_setting_enumerate_values ()

nm_setting_need_secrets ()

nm_setting_update_secrets ()

Property Details

The `"name"` property

Object Hierarchy

Properties

nm_setting_error_quark ()

NMSettingValueIterFn ()

nm_setting_get_type ()

nm_setting_to_hash ()

nm_setting_new_from_hash ()

nm_setting_verify ()

nm_setting_compare ()

nm_setting_enumerate_values ()

nm_setting_need_secrets ()

nm_setting_update_secrets ()

Property Details

The "name" property

The `"name"` property