## NMSettingPPPOE

NMSettingPPPOE

## Synopsis

    #define             NM_SETTING_PPPOE_SETTING_NAME
    enum                NMSettingPPPOEError;
    #define             NM_TYPE_SETTING_PPPOE_ERROR
    #define             NM_SETTING_PPPOE_ERROR
    GQuark              nm_setting_pppoe_error_quark        (void);
    #define             NM_SETTING_PPPOE_SERVICE
    #define             NM_SETTING_PPPOE_USERNAME
    #define             NM_SETTING_PPPOE_PASSWORD
                        NMSettingPPPOE;
                        NMSettingPPPOEClass;
    GType               nm_setting_pppoe_get_type           (void);
    NMSetting *         nm_setting_pppoe_new                (void);
    const char *        nm_setting_pppoe_get_service        (NMSettingPPPOE *setting);
    const char *        nm_setting_pppoe_get_username       (NMSettingPPPOE *setting);
    const char *        nm_setting_pppoe_get_password       (NMSettingPPPOE *setting);

## Object Hierarchy

      GObject
       +----NMSetting
             +----NMSettingPPPOE

## Properties

      "password"                 gchar*                : Read / Write
      "service"                  gchar*                : Read / Write
      "username"                 gchar*                : Read / Write

## Description

## Details

### NM_SETTING_PPPOE_SETTING_NAME

    #define NM_SETTING_PPPOE_SETTING_NAME "pppoe"

### enum NMSettingPPPOEError

    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_TYPE_SETTING_PPPOE_ERROR

    #define NM_TYPE_SETTING_PPPOE_ERROR (nm_setting_pppoe_error_get_type ())

### NM_SETTING_PPPOE_ERROR

    #define NM_SETTING_PPPOE_ERROR nm_setting_pppoe_error_quark ()

### nm_setting_pppoe_error_quark ()

    GQuark              nm_setting_pppoe_error_quark        (void);

Returns : |

### NM_SETTING_PPPOE_SERVICE

    #define NM_SETTING_PPPOE_SERVICE  "service"

### NM_SETTING_PPPOE_USERNAME

    #define NM_SETTING_PPPOE_USERNAME "username"

### NM_SETTING_PPPOE_PASSWORD

    #define NM_SETTING_PPPOE_PASSWORD "password"

### NMSettingPPPOE

    typedef struct _NMSettingPPPOE NMSettingPPPOE;

### NMSettingPPPOEClass

    typedef struct {
    	NMSettingClass parent;

    	/* Padding for future expansion */
    	void (*_reserved1) (void);
    	void (*_reserved2) (void);
    	void (*_reserved3) (void);
    	void (*_reserved4) (void);
    } NMSettingPPPOEClass;

### nm_setting_pppoe_get_type ()

    GType               nm_setting_pppoe_get_type           (void);

Returns : |

### nm_setting_pppoe_new ()

    NMSetting *         nm_setting_pppoe_new                (void);

Returns : |

### nm_setting_pppoe_get_service ()

    const char *        nm_setting_pppoe_get_service        (NMSettingPPPOE *setting);

`setting` : |
Returns : |

### nm_setting_pppoe_get_username ()

    const char *        nm_setting_pppoe_get_username       (NMSettingPPPOE *setting);

`setting` : |
Returns : |

### nm_setting_pppoe_get_password ()

    const char *        nm_setting_pppoe_get_password       (NMSettingPPPOE *setting);

`setting` : |
Returns : |

## Property Details

### The `"password"` property

      "password"                 gchar*                : Read / Write

Password used to authenticate with the PPPoE service.

Default value: NULL

### The `"service"` property

      "service"                  gchar*                : Read / Write

If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified serivce. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.

Default value: NULL

### The `"username"` property

      "username"                 gchar*                : Read / Write

Username used to authenticate with the PPPoE service.

Default value: NULL