From 263bf4c0c89bb88dc995acd9a6a2de9095fbd461 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 23 Aug 2011 19:16:47 +0200 Subject: Imported Upstream version 0.9.0 --- docs/libnm-util/html/NMSettingVPN.html | 229 +++++++++++++++++++++++++++++++-- 1 file changed, 218 insertions(+), 11 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 c2e4ce52..1c6264d0 100644 --- a/docs/libnm-util/html/NMSettingVPN.html +++ b/docs/libnm-util/html/NMSettingVPN.html @@ -35,13 +35,16 @@

NMSettingVPN

-

NMSettingVPN

+

NMSettingVPN — Describes connection properties for Virtual Private Networks

Synopsis

-
#define             NM_SETTING_VPN_SETTING_NAME
+
+#include <nm-setting-vpn.h>
+
+#define             NM_SETTING_VPN_SETTING_NAME
 enum                NMSettingVpnError;
 #define             NM_TYPE_SETTING_VPN_ERROR
 #define             NM_SETTING_VPN_ERROR
@@ -105,6 +108,13 @@ const char *        
 
Description

 

+The NMSettingVPN object is a NMSetting subclass that describes properties
+necessary for connection to Virtual Private Networks.  NetworkManager uses
+a plugin architecture to allow easier use of new VPN types, and this
+setting abstracts the configuration for those plugins.  Since the configuration
+options are only known to the VPN plugins themselves, the VPN configuration
+options are stored as key/value pairs of strings rather than GObject
+properties.
@@ -119,15 +129,33 @@ const char *

enum NMSettingVpnError

-
typedef enum
-{
+
typedef enum {
 	NM_SETTING_VPN_ERROR_UNKNOWN = 0,
 	NM_SETTING_VPN_ERROR_INVALID_PROPERTY,
 	NM_SETTING_VPN_ERROR_MISSING_PROPERTY,
 } NMSettingVpnError;
 

-

-

+

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


NM_SETTING_VPN_ERROR_UNKNOWN
unknown or unclassified error
+
NM_SETTING_VPN_ERROR_INVALID_PROPERTY
the property was invalid
+
NM_SETTING_VPN_ERROR_MISSING_PROPERTY
the property was missing and is
+required
+
@@ -150,7 +178,15 @@ const char *

nm_setting_vpn_error_quark ()

GQuark              nm_setting_vpn_error_quark          (void);

+Registers an error quark for NMSettingVPN if necessary.

+
++ + + + +

Returns :

the error quark used for NMSettingVPN errors.
@@ -213,8 +249,25 @@ const char * void (*NMVPNIterFunc) (const char *key, const char *value, gpointer user_data); -

-

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

key :

the name of the data or secret item

value :

the value of the data or secret item

user_data :

User data passed to nm_setting_vpn_foreach_data_item() or +nm_setting_vpn_foreach_secret() +
@@ -228,21 +281,58 @@ const char *

nm_setting_vpn_new ()

NMSetting *         nm_setting_vpn_new                  (void);

+Creates a new NMSettingVPN object with default values.

+
++ + + + +

Returns :

the new empty NMSettingVPN object. [transfer full] +

nm_setting_vpn_get_service_type ()

const char *        nm_setting_vpn_get_service_type     (NMSettingVPN *setting);

+Returns the service name of the VPN, which identifies the specific VPN +plugin that should be used to connect to this VPN.

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

setting :

the NMSettingVPN +

Returns :

the VPN plugin's service name

nm_setting_vpn_get_user_name ()

const char *        nm_setting_vpn_get_user_name        (NMSettingVPN *setting);
-

-

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

setting :

the NMSettingVPN +

Returns :

the "user-name" property of the setting
@@ -251,7 +341,30 @@ const char * const char *key, const char *item);

+Establishes a relationship between key and item internally in the +setting which may be retrieved later. Should not be used to store passwords +or other secrets, which is what nm_setting_vpn_add_secret() is for.

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

setting :

the NMSettingVPN +

key :

a name that uniquely identifies the given value item +

item :

the value to be referenced by key +
@@ -259,7 +372,27 @@ const char * const char * nm_setting_vpn_get_data_item (NMSettingVPN *setting, const char *key);

+Retrieves the data item of a key/value relationship previously established +by nm_setting_vpn_add_data_item().

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

setting :

the NMSettingVPN +

key :

the name of the data item to retrieve

Returns :

the data item, if any
@@ -267,7 +400,23 @@ const char * void nm_setting_vpn_remove_data_item (NMSettingVPN *setting, const char *key);

+Deletes a key/value relationship previously established by +nm_setting_vpn_add_data_item().

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

setting :

the NMSettingVPN +

key :

the name of the data item to remove
@@ -308,7 +457,29 @@ during iteration will not be part of the iteration. const char *key, const char *secret);

+Establishes a relationship between key and secret internally in the +setting which may be retrieved later.

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

setting :

the NMSettingVPN +

key :

a name that uniquely identifies the given secret secret +

secret :

the secret to be referenced by key +
@@ -316,7 +487,27 @@ during iteration will not be part of the iteration. 
const char *        nm_setting_vpn_get_secret           (NMSettingVPN *setting,
                                                          const char *key);

+Retrieves the secret of a key/value relationship previously established +by nm_setting_vpn_add_secret().

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

setting :

the NMSettingVPN +

key :

the name of the secret to retrieve

Returns :

the secret, if any
@@ -324,7 +515,23 @@ during iteration will not be part of the iteration. 
void                nm_setting_vpn_remove_secret        (NMSettingVPN *setting,
                                                          const char *key);

+Deletes a key/value relationship previously established by +nm_setting_vpn_add_secret().

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

setting :

the NMSettingVPN +

key :

the name of the secret to remove
@@ -393,7 +600,7 @@ plugin.

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.

+

If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.

Default value: NULL

-- cgit 1.3.0-6-gf8a5