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/NMSettingPPPOE.html | 75 ++++++++++++++++++++++++++++---- 1 file changed, 67 insertions(+), 8 deletions(-) (limited to 'docs/libnm-util/html/NMSettingPPPOE.html') diff --git a/docs/libnm-util/html/NMSettingPPPOE.html b/docs/libnm-util/html/NMSettingPPPOE.html index 87669254..6ea0af49 100644 --- a/docs/libnm-util/html/NMSettingPPPOE.html +++ b/docs/libnm-util/html/NMSettingPPPOE.html @@ -35,13 +35,16 @@

NMSettingPPPOE

-

NMSettingPPPOE

+

NMSettingPPPOE — Describes PPPoE connection properties

Synopsis

-
#define             NM_SETTING_PPPOE_SETTING_NAME
+
+#include <nm-setting-pppoe.h>
+
+#define             NM_SETTING_PPPOE_SETTING_NAME
 enum                NMSettingPPPOEError;
 #define             NM_TYPE_SETTING_PPPOE_ERROR
 #define             NM_SETTING_PPPOE_ERROR
@@ -85,6 +88,9 @@ const char *        
 

Description

+The NMSettingPPPOE object is a NMSetting subclass that describes +properties necessary for connection to networks that require PPPoE connections +to provide IP transport, for example cable or DSL modems.

@@ -99,16 +105,40 @@ const char *

enum NMSettingPPPOEError

-
typedef enum
-{
+
typedef enum {
 	NM_SETTING_PPPOE_ERROR_UNKNOWN = 0,
 	NM_SETTING_PPPOE_ERROR_INVALID_PROPERTY,
 	NM_SETTING_PPPOE_ERROR_MISSING_PROPERTY,
 	NM_SETTING_PPPOE_ERROR_MISSING_PPP_SETTING
 } NMSettingPPPOEError;
 
-

-

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

NM_SETTING_PPPOE_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_PPPOE_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_PPPOE_ERROR_MISSING_PROPERTY

the property was missing and is +required +

NM_SETTING_PPPOE_ERROR_MISSING_PPP_SETTING

the connection +did not contain a required PPP setting for PPP related options +

@@ -131,7 +161,15 @@ const char *

nm_setting_pppoe_error_quark ()

GQuark              nm_setting_pppoe_error_quark        (void);

+Registers an error quark for NMSettingPPPOE if necessary.

+
++ + + + +

Returns :

the error quark used for NMSettingPPPOE errors.

@@ -200,14 +238,35 @@ const char *

nm_setting_pppoe_new ()

NMSetting *         nm_setting_pppoe_new                (void);

+Creates a new NMSettingPPPOE object with default values.

+
++ + + + +

Returns :

the new empty NMSettingPPPOE object. [transfer full] +

nm_setting_pppoe_get_service ()

const char *        nm_setting_pppoe_get_service        (NMSettingPPPOE *setting);
-

-

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

setting :

the NMSettingPPPOE +

Returns :

the "password" property of the setting

-- cgit 1.3.0-6-gf8a5