From d9c99a29a0d3384c9c3d2adce430f5cb1134ab6a Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Wed, 30 Mar 2016 00:56:30 +0200 Subject: Imported Upstream version 1.1.92 --- docs/libnm/html/NMSetting.html | 122 ++++++++++++++++++++--------------------- 1 file changed, 61 insertions(+), 61 deletions(-) (limited to 'docs/libnm/html/NMSetting.html') diff --git a/docs/libnm/html/NMSetting.html b/docs/libnm/html/NMSetting.html index a0fdf80f..65b56b96 100644 --- a/docs/libnm/html/NMSetting.html +++ b/docs/libnm/html/NMSetting.html @@ -55,7 +55,7 @@ -gboolean +gboolean (*NMSettingClearSecretsWithFlagsFn) () @@ -71,7 +71,7 @@ -GType +GType nm_setting_lookup_type () @@ -94,7 +94,7 @@ -gboolean +gboolean nm_setting_verify () @@ -102,7 +102,7 @@ -gboolean +gboolean nm_setting_verify_secrets () @@ -110,7 +110,7 @@ -gboolean +gboolean nm_setting_compare () @@ -118,7 +118,7 @@ -gboolean +gboolean nm_setting_diff () @@ -142,7 +142,7 @@ -gboolean +gboolean nm_setting_get_secret_flags () @@ -150,14 +150,14 @@ -gboolean +gboolean nm_setting_set_secret_flags () -const GVariantType * +const GVariantType * nm_setting_get_dbus_property_type () @@ -176,7 +176,7 @@ -gchar * +gchar * name Read @@ -219,13 +219,13 @@

Object Hierarchy

-
    GEnum
+
    GEnum
     ├── NMSettingCompareFlags
     ├── NMSettingDiffResult
     ╰── NMSettingMacRandomization
-    GFlags
+    GFlags
     ╰── NMSettingSecretFlags
-    GObject
+    GObject
     ╰── NMSetting
         ├── NMSetting8021x
         ├── NMSettingAdsl
@@ -263,7 +263,7 @@
 
Each NMSetting contains properties that describe configuration that applies
 to a specific network layer (like IPv4 or IPv6 configuration) or device type
 (like Ethernet, or Wi-Fi).  A collection of individual settings together
-make up an NMConnection. Each property is strongly typed and usually has
+make up an NMConnection. Each property is strongly typed and usually has
 a number of allowed values.  See each NMSetting subclass for a description
 of properties and allowed values.
@@ -289,11 +289,11 @@ of properties and allowed values.

NMSettingClearSecretsWithFlagsFn ()

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

+                                     gpointer user_data);

Parameters

@@ -328,7 +328,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

@@ -337,9 +337,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

@@ -382,9 +382,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
@@ -402,7 +402,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.

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

nm_setting_verify ()

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

+                   NMConnection *connection,
+                   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

@@ -490,15 +490,15 @@ failed validation, and in what way that property failed validation.

 - - + @@ -506,18 +506,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);

+                           NMConnection *connection,
+                           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.

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

 - - + @@ -553,14 +553,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);

@@ -596,18 +596,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 @@ -641,7 +641,7 @@ one or more

invert_results

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

 @@ -658,7 +658,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

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

@@ -726,17 +726,17 @@ 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 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.

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

 - + @@ -773,18 +773,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.

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

 - + @@ -821,19 +821,19 @@ 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_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

connection

the NMConnection that setting +

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

[allow-none]

error

location to store error, or NULL

location to store error, or NULL

  

connection

the NMConnection that setting +

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

[allow-none]

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

  
@@ -1140,7 +1140,7 @@ if you specify NM_SETTING_COMPARE_FLAG_DIFF_RESULT_W

Property 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".

-- cgit 1.3.0-6-gf8a5