## NMDeviceVlan

NMDeviceVlan

## Synopsis

    enum                NMDeviceVlanError;
    #define             NM_DEVICE_VLAN_ERROR
    GQuark              nm_device_vlan_error_quark          (void);
    #define             NM_DEVICE_VLAN_HW_ADDRESS
    #define             NM_DEVICE_VLAN_CARRIER
    #define             NM_DEVICE_VLAN_VLAN_ID
                        NMDeviceVlan;
                        NMDeviceVlanClass;
    GObject *           nm_device_vlan_new                  (DBusGConnection *connection,
                                                             const char *path);
    const char *        nm_device_vlan_get_hw_address       (NMDeviceVlan *device);
    gboolean            nm_device_vlan_get_carrier          (NMDeviceVlan *device);
    guint               nm_device_vlan_get_vlan_id          (NMDeviceVlan *device);

## Object Hierarchy

      GObject
       +----NMObject
             +----NMDevice
                   +----NMDeviceVlan

## Implemented Interfaces

NMDeviceVlan implements GInitable and GAsyncInitable.

## Properties

      "carrier"                  gboolean              : Read
      "hw-address"               gchar*                : Read
      "vlan-id"                  guint                 : Read

## Description

## Details

### enum NMDeviceVlanError

    typedef enum {
    	NM_DEVICE_VLAN_ERROR_UNKNOWN = 0,             /*< nick=UnknownError >*/
    	NM_DEVICE_VLAN_ERROR_NOT_VLAN_CONNECTION,     /*< nick=NotVlanConnection >*/
    	NM_DEVICE_VLAN_ERROR_INVALID_VLAN_CONNECTION, /*< nick=InvalidVlanConnection >*/
    	NM_DEVICE_VLAN_ERROR_ID_MISMATCH,             /*< nick=IdMismatch >*/
    	NM_DEVICE_VLAN_ERROR_INTERFACE_MISMATCH,      /*< nick=InterfaceMismatch >*/
    } NMDeviceVlanError;

`NM_DEVICE_VLAN_ERROR_UNKNOWN` | unknown or unclassified error
`NM_DEVICE_VLAN_ERROR_NOT_VLAN_CONNECTION` | the connection was not of VLAN type
`NM_DEVICE_VLAN_ERROR_INVALID_VLAN_CONNECTION` | the VLAN connection was invalid
`NM_DEVICE_VLAN_ERROR_ID_MISMATCH` | the VLAN identifiers of the connection and the device mismatched
`NM_DEVICE_VLAN_ERROR_INTERFACE_MISMATCH` | the interfaces of the connection and the device mismatched

### NM_DEVICE_VLAN_ERROR

    #define NM_DEVICE_VLAN_ERROR nm_device_vlan_error_quark ()

### nm_device_vlan_error_quark ()

    GQuark              nm_device_vlan_error_quark          (void);

Registers an error quark for NMDeviceVlan if necessary.

Returns : | the error quark used for NMDeviceVlan errors.

### NM_DEVICE_VLAN_HW_ADDRESS

    #define NM_DEVICE_VLAN_HW_ADDRESS  "hw-address"

### NM_DEVICE_VLAN_CARRIER

    #define NM_DEVICE_VLAN_CARRIER     "carrier"

### NM_DEVICE_VLAN_VLAN_ID

    #define NM_DEVICE_VLAN_VLAN_ID     "vlan-id"

### NMDeviceVlan

    typedef struct _NMDeviceVlan NMDeviceVlan;

### NMDeviceVlanClass

    typedef struct {
    	NMDeviceClass parent;

    	/* Padding for future expansion */
    	void (*_reserved1) (void);
    	void (*_reserved2) (void);
    	void (*_reserved3) (void);
    	void (*_reserved4) (void);
    	void (*_reserved5) (void);
    	void (*_reserved6) (void);
    } NMDeviceVlanClass;

### nm_device_vlan_new ()

    GObject *           nm_device_vlan_new                  (DBusGConnection *connection,
                                                             const char *path);

Creates a new NMDeviceVlan.

`connection` : | the DBusGConnection
`path` : | the DBus object path of the device
Returns : | a new device. [transfer full]

### nm_device_vlan_get_hw_address ()

    const char *        nm_device_vlan_get_hw_address       (NMDeviceVlan *device);

Gets the hardware (MAC) address of the NMDeviceVlan

`device` : | a NMDeviceVlan
Returns : | the hardware address. This is the internal string used by the device, and must not be modified.

### nm_device_vlan_get_carrier ()

    gboolean            nm_device_vlan_get_carrier          (NMDeviceVlan *device);

Whether the device has carrier.

`device` : | a NMDeviceVlan
Returns : | `TRUE` if the device has carrier

### nm_device_vlan_get_vlan_id ()

    guint               nm_device_vlan_get_vlan_id          (NMDeviceVlan *device);

`device` : | a NMDeviceVlan
Returns : | the device's VLAN ID

## Property Details

### The `"carrier"` property

      "carrier"                  gboolean              : Read

Whether the device has carrier.

Default value: FALSE

### The `"hw-address"` property

      "hw-address"               gchar*                : Read

The hardware (MAC) address of the device.

Default value: NULL

### The `"vlan-id"` property

      "vlan-id"                  guint                 : Read

The device's VLAN ID.

Allowed values: <= 4095

Default value: 0