From 45cb5bb3c0e6edb887cf69b417fcaf7053814a9b Mon Sep 17 00:00:00 2001 From: Aron Xu Date: Tue, 20 Dec 2016 20:06:37 +0800 Subject: Imported Upstream version 1.4.4 --- docs/libnm-util/html/NMSetting.html | 184 ++++++++++++++++++------------------ 1 file changed, 92 insertions(+), 92 deletions(-) (limited to 'docs/libnm-util/html/NMSetting.html') diff --git a/docs/libnm-util/html/NMSetting.html b/docs/libnm-util/html/NMSetting.html index 2a366f0e..ce49fa96 100644 --- a/docs/libnm-util/html/NMSetting.html +++ b/docs/libnm-util/html/NMSetting.html @@ -3,7 +3,7 @@ NMSetting: libnm-util Reference Manual - + @@ -35,7 +35,7 @@

Functions

-
+
@@ -43,7 +43,7 @@
-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 () @@ -196,7 +196,7 @@

Properties

-
+
@@ -204,7 +204,7 @@ +gchar * @@ -212,7 +212,7 @@

Types and Values

-
-gchar * name Read / Write
+
@@ -277,7 +277,7 @@ ├── NMSettingError ├── NMSettingHashFlags ╰── NMSettingSecretFlags - GObject + GObject╰── NMSetting ├──NMSetting8021x├──NMSettingAdsl @@ -325,7 +325,7 @@ of properties and allowed values.

Functions

nm_setting_error_quark ()

-
GQuark
+
GQuark
 nm_setting_error_quark (void);

 
Registers an error quark for NMSetting if necessary.

 

@@ -336,14 +336,14 @@ nm_setting_error_quark (void
 

 
NMSettingClearSecretsWithFlagsFn ()

-
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

Returns

-

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

+

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

@@ -384,12 +384,12 @@ 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,15 +429,15 @@ nm_setting_error_quark (void

nm_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.

 

 
Parameters

-
+
@@ -459,7 +459,7 @@ D-Bus or serializing. The mapping is string to GValue.

Returns

-

a new GHashTable +

a new GHashTable describing the setting's properties.

[transfer full][element-type utf8 GObject.Value]

@@ -468,8 +468,8 @@ describing the setting's properties.

nm_setting_new_from_hash ()

NMSetting *
-nm_setting_new_from_hash (GType setting_type,
-                          GHashTable *hash);
+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, and each hash value as the value to set that property to. Setting properties @@ -478,7 +478,7 @@ See the documentation on each

Parameters

-
+
@@ -492,7 +492,7 @@ property names and value types.

 - @@ -502,7 +502,7 @@ string to GValue mapping of properties that apply to the setting.

Returns

a new NMSetting object populated with the properties from the -hash table, or NULL on failure

+hash table, or NULL on failure

@@ -513,7 +513,7 @@ nm_setting_duplicate (NMSetting.

Parameters

-

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]
+
@@ -541,7 +541,7 @@ nm_setting_get_name (NMSetting object

Parameters

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

 - - + @@ -603,13 +603,13 @@ came.

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_compare ()

-
gboolean
+
gboolean
 nm_setting_compare (NMSetting *a,
                     NMSetting *b,
                     NMSettingCompareFlags flags);

@@ -618,7 +618,7 @@ modified by a set of flags.  See the documentation for 
 
Parameters

-

all_settings

a GSList of all settings +

a GSList of all settings in the connection from which setting came.

[element-type NMSetting]

error

location to store error, or NULL

location to store error, or NULL

  
+
@@ -645,18 +645,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 @@ -665,7 +665,7 @@ of each setting that differ from the other are added to NMSettingDiffResult values.

Parameters

-
+
@@ -690,7 +690,7 @@ one or more

invert_results

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

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

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

Parameters

-

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

 
+
@@ -758,7 +758,7 @@ be used for serialization of the setting, or machine-parsed in any way. The output format is not guaranteed to be stable and may change at any time.

Parameters

-
+
@@ -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 g_free()

+free with g_free()

@@ -788,7 +788,7 @@ setting only when needed, and cleared immediately after use to prevent leakage of information.

Parameters

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

Parameters

-
+
@@ -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
@@ -852,7 +852,7 @@ guide to what secrets may be required, because in some circumstances, there
 is no way to conclusively determine exactly which secrets are needed.

 

 
Parameters

-
+
@@ -867,9 +867,9 @@ is no way to conclusively determine exactly which secrets are needed.

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 with g_ptr_array_free(), but must not free the elements.

[transfer container][element-type utf8]

@@ -877,15 +877,15 @@ free the elements.

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).

Parameters

-
+
@@ -899,13 +899,13 @@ setting (deserialized from D-Bus for example).

 - + - + @@ -913,23 +913,23 @@ string to

Returns

-

TRUE if the secrets were successfully updated, FALSE on failure to +

TRUE if the secrets were successfully updated, FALSE on 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.

Parameters

-

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]

error

location to store error, or NULL

location to store error, or NULL

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

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

Parameters

-

error

location to store error, or NULL

location to store error, or NULL

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

 - + @@ -1009,8 +1009,8 @@ 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

@@ -1022,7 +1022,7 @@ nm_setting_get_virtual_iface_name (

Parameters

-

error

location to store error, or NULL

location to store error, or NULL

  
+
@@ -1037,7 +1037,7 @@ needs to use if specified in the settings.

Returns

-

Name of the virtual interface or NULL if the setting does not +

Name of the virtual interface or NULL if the setting does not support this feature

@@ -1049,7 +1049,7 @@ support this feature

Describes errors that may result from operations involving a NMSetting.

Members

-
+
@@ -1136,7 +1136,7 @@ secret has a corresponding set of these flags which indicate how the secret is to be stored and/or requested when it is needed.

Members

-
+
@@ -1189,7 +1189,7 @@ secret is not required

two connections.

Members

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

when calling nm_setting_to_hash().

Members

-
+
@@ -1334,7 +1334,7 @@ when calling

Members

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