From de06e5715e780baade318f3490ac7a4c9ce84e32 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sat, 24 Mar 2012 01:37:02 +0100 Subject: Imported Upstream version 0.9.4.0 --- docs/libnm-util/html/NMSetting.html | 124 ++++++++++++++++++++++++++---------- 1 file changed, 89 insertions(+), 35 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 63319e1a..3e64eeb0 100644 --- a/docs/libnm-util/html/NMSetting.html +++ b/docs/libnm-util/html/NMSetting.html @@ -41,25 +41,26 @@

Synopsis

-
+
 #include <nm-setting.h>
 
                     NMSetting;
                     NMSettingClass;
 gboolean            (*NMSettingClearSecretsWithFlagsFn) (NMSetting *setting,
                                                          const char *secret,
-                                                         NMSettingSecretFlags flags,
+                                                         NMSettingSecretFlags flags,
                                                          gpointer user_data);
-enum                NMSettingCompareFlags;
-enum                NMSettingDiffResult;
+enum                NMSettingCompareFlags;
+enum                NMSettingDiffResult;
 enum                NMSettingError;
-enum                NMSettingHashFlags;
-enum                NMSettingSecretFlags;
+enum                NMSettingHashFlags;
+enum                NMSettingSecretFlags;
 void                (*NMSettingValueIterFn)             (NMSetting *setting,
                                                          const char *key,
                                                          const GValue *value,
                                                          GParamFlags flags,
                                                          gpointer user_data);
+#define             NM_SETTING_ERROR
 #define             NM_SETTING_NAME
 #define             NM_SETTING_PARAM_FUZZY_IGNORE
 #define             NM_SETTING_PARAM_REQUIRED
@@ -71,10 +72,10 @@ enum                gpointer user_data);
 gboolean            nm_setting_compare                  (NMSetting *a,
                                                          NMSetting *b,
-                                                         NMSettingCompareFlags flags);
+                                                         NMSettingCompareFlags flags);
 gboolean            nm_setting_diff                     (NMSetting *a,
                                                          NMSetting *b,
-                                                         NMSettingCompareFlags flags,
+                                                         NMSettingCompareFlags flags,
                                                          gboolean invert_results,
                                                          GHashTable **results);
 NMSetting *         nm_setting_duplicate                (NMSetting *setting);
@@ -85,17 +86,18 @@ enum                char *        nm_setting_get_name                 (NMSetting *setting);
 gboolean            nm_setting_get_secret_flags         (NMSetting *setting,
                                                          const char *secret_name,
-                                                         NMSettingSecretFlags *out_flags,
+                                                         NMSettingSecretFlags *out_flags,
                                                          GError **error);
+const char *        nm_setting_get_virtual_iface_name   (NMSetting *setting);
 GPtrArray *         nm_setting_need_secrets             (NMSetting *setting);
 NMSetting *         nm_setting_new_from_hash            (GType setting_type,
                                                          GHashTable *hash);
 gboolean            nm_setting_set_secret_flags         (NMSetting *setting,
                                                          const char *secret_name,
-                                                         NMSettingSecretFlags flags,
+                                                         NMSettingSecretFlags flags,
                                                          GError **error);
 GHashTable *        nm_setting_to_hash                  (NMSetting *setting,
-                                                         NMSettingHashFlags flags);
+                                                         NMSettingHashFlags flags);
 char *              nm_setting_to_string                (NMSetting *setting);
 gboolean            nm_setting_update_secrets           (NMSetting *setting,
                                                          GHashTable *secrets,
@@ -112,25 +114,44 @@ const char *        NMSetting8021x
          +----NMSettingBluetooth
+         +----NMSettingBond
          +----NMSettingCdma
          +----NMSettingConnection
          +----NMSettingGsm
+         +----NMSettingInfiniband
          +----NMSettingIP4Config
          +----NMSettingIP6Config
          +----NMSettingOlpcMesh
          +----NMSettingPPP
          +----NMSettingPPPOE
          +----NMSettingSerial
+         +----NMSettingVlan
          +----NMSettingVPN
          +----NMSettingWimax
          +----NMSettingWired
          +----NMSettingWireless
          +----NMSettingWirelessSecurity
 

+
+  GEnum
+   +----NMSettingCompareFlags
+

+
+  GEnum
+   +----NMSettingDiffResult
+

 
   GEnum
    +----NMSettingError
 

+
+  GEnum
+   +----NMSettingHashFlags
+

+
+  GEnum
+   +----NMSettingSecretFlags
+

Properties

@@ -200,9 +221,10 @@ It should only be accessed through the functions described below. NMSettingClearSecretsWithFlagsFn func, gpointer user_data); + const char *(*get_virtual_iface_name) (NMSetting *setting); + /* Padding for future expansion */ void (*_reserved1) (void); - void (*_reserved2) (void); } NMSettingClass;

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

NMSettingClearSecretsWithFlagsFn ()

gboolean            (*NMSettingClearSecretsWithFlagsFn) (NMSetting *setting,
                                                          const char *secret,
-                                                         NMSettingSecretFlags flags,
+                                                         NMSettingSecretFlags flags,
                                                          gpointer user_data);
@@ -246,7 +268,7 @@ It should only be accessed through the functions described below.
-

enum NMSettingCompareFlags

+

enum NMSettingCompareFlags

typedef enum {
 	NM_SETTING_COMPARE_FLAG_EXACT = 0x00000000,
 	NM_SETTING_COMPARE_FLAG_FUZZY = 0x00000001,
@@ -304,7 +326,7 @@ storage (ie, the secret's flag includes NM_SETTING_S
-

enum NMSettingDiffResult

+

enum NMSettingDiffResult

typedef enum {
 	NM_SETTING_DIFF_RESULT_UNKNOWN = 0x00000000,
 	NM_SETTING_DIFF_RESULT_IN_A =    0x00000001,
@@ -339,10 +361,10 @@ These values indicate the result of a setting difference operation.
 

 
enum NMSettingError

 
typedef enum {
-	NM_SETTING_ERROR_UNKNOWN = 0,
-	NM_SETTING_ERROR_PROPERTY_NOT_FOUND,
-	NM_SETTING_ERROR_PROPERTY_NOT_SECRET,
-	NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH
+	NM_SETTING_ERROR_UNKNOWN = 0,           /*< nick=UnknownError >*/
+	NM_SETTING_ERROR_PROPERTY_NOT_FOUND,    /*< nick=PropertyNotFound >*/
+	NM_SETTING_ERROR_PROPERTY_NOT_SECRET,   /*< nick=PropertyNotSecret >*/
+	NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH /*< nick=PropertyTypeMismatch >*/
 } NMSettingError;
 

 

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

 

-
enum NMSettingHashFlags

+
enum NMSettingHashFlags

 
typedef enum {
 	NM_SETTING_HASH_FLAG_ALL = 0x00000000,
 	NM_SETTING_HASH_FLAG_NO_SECRETS = 0x00000001,
@@ -414,7 +436,7 @@ when calling 
-
enum NMSettingSecretFlags

+
enum NMSettingSecretFlags

 
typedef enum {
 	NM_SETTING_SECRET_FLAG_NONE         = 0x00000000,
 	NM_SETTING_SECRET_FLAG_AGENT_OWNED  = 0x00000001,
@@ -502,6 +524,14 @@ secret is not required
 

 

 

+
NM_SETTING_ERROR

+
#define NM_SETTING_ERROR nm_setting_error_quark ()
+

+

+

+

+

+

 
NM_SETTING_NAME

 
#define NM_SETTING_NAME "name"
 

@@ -594,10 +624,10 @@ specific secret should be cleared or not. [
nm_setting_compare ()

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

+                                                         NMSettingCompareFlags flags);

Compares two NMSetting objects for similarity, with comparison behavior -modified by a set of flags. See the documentation for NMSettingCompareFlags +modified by a set of flags. See the documentation for NMSettingCompareFlags for a description of each flag's behavior.

@@ -630,15 +660,15 @@ for a description of each flag's behavior.

nm_setting_diff ()

gboolean            nm_setting_diff                     (NMSetting *a,
                                                          NMSetting *b,
-                                                         NMSettingCompareFlags flags,
+                                                         NMSettingCompareFlags flags,
                                                          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 +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 of each setting that differ from the other are added to results, mapped to -one or more NMSettingDiffResult values. +one or more NMSettingDiffResult values.

@@ -660,13 +690,13 @@ one or more invert_results :

 +be set to FALSE. If TRUE inverts the meaning of the NMSettingDiffResult. @@ -775,10 +805,10 @@ like 'ppp' or 'wireless' or 'wired'.

nm_setting_get_secret_flags ()

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

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

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

results :

 if the settings differ, on return a hash table mapping the differing keys to one or -more NMSettingDiffResult values OR-ed together. If the settings do not +more NMSettingDiffResult values OR-ed together. If the settings do not differ, any hash table passed in is unmodified. If no hash table is passed in and the settings differ, a new one is created and returned. [inout][transfer full][element-type utf8 guint32]
@@ -795,7 +825,7 @@ handle that secret. - + @@ -812,6 +842,30 @@ this setting, and if that property is secret), FALSE if not
+

nm_setting_get_virtual_iface_name ()

+
const char *        nm_setting_get_virtual_iface_name   (NMSetting *setting);
+

+Returns the name of the virtual kernel interface which the connection +needs to use if specified in the settings. +

+

out_flags :

on success, the NMSettingSecretFlags for the secreton success, the NMSettingSecretFlags for the secret

error :

++ + + + + + + + + + +

setting :

the NMSetting +

Returns :

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

nm_setting_need_secrets ()

GPtrArray *         nm_setting_need_secrets             (NMSetting *setting);

@@ -878,10 +932,10 @@ hash table, or NULL on failure

nm_setting_set_secret_flags ()

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

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

@@ -898,7 +952,7 @@ handle that secret. - + @@ -917,7 +971,7 @@ this setting, and if that property is secret), FALSE if not

nm_setting_to_hash ()

GHashTable *        nm_setting_to_hash                  (NMSetting *setting,
-                                                         NMSettingHashFlags flags);
+ NMSettingHashFlags flags);

Converts the NMSetting into a GHashTable mapping each setting property name to a GValue describing that property, suitable for marshalling over -- cgit 1.3.0-6-gf8a5

flags :

the NMSettingSecretFlags for the secretthe NMSettingSecretFlags for the secret

error :