From f75dd6fd1975146623052b843b182dc32c3fbe46 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 8 Apr 2011 07:30:59 +0200 Subject: Imported Upstream version 0.8.998 --- docs/libnm-util/html/NMSettingVPN.html | 296 +++++++-------------------------- 1 file changed, 59 insertions(+), 237 deletions(-) (limited to 'docs/libnm-util/html/NMSettingVPN.html') diff --git a/docs/libnm-util/html/NMSettingVPN.html b/docs/libnm-util/html/NMSettingVPN.html index 16df44cb..e8cd2fb9 100644 --- a/docs/libnm-util/html/NMSettingVPN.html +++ b/docs/libnm-util/html/NMSettingVPN.html @@ -3,12 +3,12 @@ NMSettingVPN - + - + @@ -30,7 +30,7 @@ Properties -
+
@@ -39,10 +39,10 @@
-
+

Synopsis

-
#define             NM_SETTING_VPN_SETTING_NAME
-enum                NMSettingVpnError;
+
#define             NM_SETTING_VPN_SETTING_NAME
+enum                NMSettingVpnError;
 #define             NM_TYPE_SETTING_VPN_ERROR
 #define             NM_SETTING_VPN_ERROR
 GQuark              nm_setting_vpn_error_quark          (void);
@@ -52,7 +52,7 @@ enum                NM_SETTING_VPN_SECRETS
                     NMSettingVPN;
                     NMSettingVPNClass;
-void                (*VPNIterFunc)                      (const char *key,
+void                (*NMVPNIterFunc)                    (const char *key,
                                                          const char *value,
                                                          gpointer user_data);
 GType               nm_setting_vpn_get_type             (void);
@@ -67,7 +67,7 @@ const char *        void                nm_setting_vpn_remove_data_item     (NMSettingVPN *setting,
                                                          const char *key);
 void                nm_setting_vpn_foreach_data_item    (NMSettingVPN *setting,
-                                                         VPNIterFunc func,
+                                                         NMVPNIterFunc func,
                                                          gpointer user_data);
 void                nm_setting_vpn_add_secret           (NMSettingVPN *setting,
                                                          const char *key,
@@ -77,19 +77,23 @@ const char *        void                nm_setting_vpn_remove_secret        (NMSettingVPN *setting,
                                                          const char *key);
 void                nm_setting_vpn_foreach_secret       (NMSettingVPN *setting,
-                                                         VPNIterFunc func,
+                                                         NMVPNIterFunc func,
                                                          gpointer user_data);
 
-
+

Object Hierarchy

+
+  GEnum
+   +----NMSettingVpnError
+
   GObject
    +----NMSetting
          +----NMSettingVPN
 
-
+

Properties

   "data"                     GHashTable_gchararray+gchararray_*  : Read / Write
@@ -98,14 +102,14 @@ const char *        user-name"                gchar*                : Read / Write
 
-
+

Description

-
+

Details

-
+

NM_SETTING_VPN_SETTING_NAME

#define NM_SETTING_VPN_SETTING_NAME "vpn"
 
@@ -113,7 +117,7 @@ const char * +

enum NMSettingVpnError

typedef enum
 {
@@ -126,7 +130,7 @@ const char *        
+

NM_TYPE_SETTING_VPN_ERROR

#define NM_TYPE_SETTING_VPN_ERROR (nm_setting_vpn_error_get_type ()) 
 
@@ -134,7 +138,7 @@ const char * +

NM_SETTING_VPN_ERROR

#define NM_SETTING_VPN_ERROR nm_setting_vpn_error_quark ()
 
@@ -142,22 +146,14 @@ const char * +

nm_setting_vpn_error_quark ()

GQuark              nm_setting_vpn_error_quark          (void);

-
-- - - - -

Returns :

-

-
+

NM_SETTING_VPN_SERVICE_TYPE

#define NM_SETTING_VPN_SERVICE_TYPE "service-type"
 
@@ -165,7 +161,7 @@ const char * +

NM_SETTING_VPN_USER_NAME

#define NM_SETTING_VPN_USER_NAME    "user-name"
 
@@ -173,7 +169,7 @@ const char * +

NM_SETTING_VPN_DATA

#define NM_SETTING_VPN_DATA         "data"
 
@@ -181,7 +177,7 @@ const char * +

NM_SETTING_VPN_SECRETS

#define NM_SETTING_VPN_SECRETS      "secrets"
 
@@ -189,14 +185,14 @@ const char * +

NMSettingVPN

typedef struct _NMSettingVPN NMSettingVPN;


-
+

NMSettingVPNClass

typedef struct {
 	NMSettingClass parent;
@@ -212,330 +208,156 @@ const char *        
-

VPNIterFunc ()

-
void                (*VPNIterFunc)                      (const char *key,
+
+

NMVPNIterFunc ()

+
void                (*NMVPNIterFunc)                    (const char *key,
                                                          const char *value,
                                                          gpointer user_data);

-
-- - - - - - - - - - - - - - -

key :

-

value :

-

user_data :

-

-
+

nm_setting_vpn_get_type ()

GType               nm_setting_vpn_get_type             (void);

-
-- - - - -

Returns :

-

-
+

nm_setting_vpn_new ()

NMSetting *         nm_setting_vpn_new                  (void);

-
-- - - - -

Returns :

-

-
+

nm_setting_vpn_get_service_type ()

const char *        nm_setting_vpn_get_service_type     (NMSettingVPN *setting);

-
-- - - - - - - - - - -

setting :

-

Returns :

-

-
+

nm_setting_vpn_get_user_name ()

const char *        nm_setting_vpn_get_user_name        (NMSettingVPN *setting);

-
-- - - - - - - - - - -

setting :

-

Returns :

-

-
+

nm_setting_vpn_add_data_item ()

void                nm_setting_vpn_add_data_item        (NMSettingVPN *setting,
                                                          const char *key,
                                                          const char *item);

-
-- - - - - - - - - - - - - - -

setting :

-

key :

-

item :

-

-
+

nm_setting_vpn_get_data_item ()

const char *        nm_setting_vpn_get_data_item        (NMSettingVPN *setting,
                                                          const char *key);

-
-- - - - - - - - - - - - - - -

setting :

-

key :

-

Returns :

-

-
+

nm_setting_vpn_remove_data_item ()

void                nm_setting_vpn_remove_data_item     (NMSettingVPN *setting,
                                                          const char *key);

-
-- - - - - - - - - - -

setting :

-

key :

-

-
+

nm_setting_vpn_foreach_data_item ()

void                nm_setting_vpn_foreach_data_item    (NMSettingVPN *setting,
-                                                         VPNIterFunc func,
+                                                         NMVPNIterFunc func,
                                                          gpointer user_data);

+Iterates all data items stored in this setting

- - -

setting :

+a NMSettingVPN

func :

+an user provided function. [scope call]

user_data :

+data to be passed to func

-
+

nm_setting_vpn_add_secret ()

void                nm_setting_vpn_add_secret           (NMSettingVPN *setting,
                                                          const char *key,
                                                          const char *secret);

-
-- - - - - - - - - - - - - - -

setting :

-

key :

-

secret :

-

-
+

nm_setting_vpn_get_secret ()

const char *        nm_setting_vpn_get_secret           (NMSettingVPN *setting,
                                                          const char *key);

-
-- - - - - - - - - - - - - - -

setting :

-

key :

-

Returns :

-

-
+

nm_setting_vpn_remove_secret ()

void                nm_setting_vpn_remove_secret        (NMSettingVPN *setting,
                                                          const char *key);

-
-- - - - - - - - - - -

setting :

-

key :

-

-
+

nm_setting_vpn_foreach_secret ()

void                nm_setting_vpn_foreach_secret       (NMSettingVPN *setting,
-                                                         VPNIterFunc func,
+                                                         NMVPNIterFunc func,
                                                          gpointer user_data);

+Iterates all secrets stored in this setting.

- - -

setting :

+a NMSettingVPN

func :

+an user provided function. [scope call]

user_data :

+data to be passed to func
-
+

Property Details

-
+

The "data" property

  "data"                     GHashTable_gchararray+gchararray_*  : Read / Write

@@ -544,7 +366,7 @@ and values must be strings.


-
+

The "secrets" property

  "secrets"                  GHashTable_gchararray+gchararray_*  : Read / Write

@@ -553,7 +375,7 @@ passwords or private keys. Both keys and values must be strings.


-
+

The "service-type" property

  "service-type"             gchar*                : Read / Write

@@ -564,7 +386,7 @@ plugin.

Default value: NULL


-
+

The "user-name" property

  "user-name"                gchar*                : Read / Write

User name of the currently logged in user for connections provided by the user settings service. This name is provided to the VPN plugin to use in lieu of a custom username provided by that VPN plugins specific configuration. The VPN plugin itself decides which user name to use.

@@ -574,6 +396,6 @@ plugin.
+ Generated by GTK-Doc V1.17
\ No newline at end of file -- cgit 1.3.0-6-gf8a5