## NMAccessPoint

NMAccessPoint

## Synopsis

    #define             NM_ACCESS_POINT_FLAGS
    #define             NM_ACCESS_POINT_WPA_FLAGS
    #define             NM_ACCESS_POINT_RSN_FLAGS
    #define             NM_ACCESS_POINT_SSID
    #define             NM_ACCESS_POINT_FREQUENCY
    #define             NM_ACCESS_POINT_HW_ADDRESS
    #define             NM_ACCESS_POINT_MODE
    #define             NM_ACCESS_POINT_MAX_BITRATE
    #define             NM_ACCESS_POINT_STRENGTH
                        NMAccessPoint;
    GObject *           nm_access_point_new                 (DBusGConnection *connection,
                                                             const char *path);
    guint32             nm_access_point_get_flags           (NMAccessPoint *ap);
    guint32             nm_access_point_get_wpa_flags       (NMAccessPoint *ap);
    guint32             nm_access_point_get_rsn_flags       (NMAccessPoint *ap);
    const GByteArray *  nm_access_point_get_ssid            (NMAccessPoint *ap);
    guint32             nm_access_point_get_frequency       (NMAccessPoint *ap);
    const char *        nm_access_point_get_hw_address      (NMAccessPoint *ap);
    NM80211Mode         nm_access_point_get_mode            (NMAccessPoint *ap);
    guint32             nm_access_point_get_max_bitrate     (NMAccessPoint *ap);
    guint8              nm_access_point_get_strength        (NMAccessPoint *ap);

## Object Hierarchy

      GObject
       +----NMObject
             +----NMAccessPoint

## Properties

      "flags"                    guint                 : Read
      "frequency"                guint                 : Read
      "hw-address"               gchar*                : Read
      "max-bitrate"              guint                 : Read
      "mode"                     guint                 : Read
      "rsn-flags"                guint                 : Read
      "ssid"                     nm-ssid*              : Read
      "strength"                 guchar                : Read
      "wpa-flags"                guint                 : Read

## Description

## Details

### NM_ACCESS_POINT_FLAGS

    #define NM_ACCESS_POINT_FLAGS      "flags"

### NM_ACCESS_POINT_WPA_FLAGS

    #define NM_ACCESS_POINT_WPA_FLAGS  "wpa-flags"

### NM_ACCESS_POINT_RSN_FLAGS

    #define NM_ACCESS_POINT_RSN_FLAGS  "rsn-flags"

### NM_ACCESS_POINT_SSID

    #define NM_ACCESS_POINT_SSID       "ssid"

### NM_ACCESS_POINT_FREQUENCY

    #define NM_ACCESS_POINT_FREQUENCY  "frequency"

### NM_ACCESS_POINT_HW_ADDRESS

    #define NM_ACCESS_POINT_HW_ADDRESS "hw-address"

### NM_ACCESS_POINT_MODE

    #define NM_ACCESS_POINT_MODE       "mode"

### NM_ACCESS_POINT_MAX_BITRATE

    #define NM_ACCESS_POINT_MAX_BITRATE   "max-bitrate"

### NM_ACCESS_POINT_STRENGTH

    #define NM_ACCESS_POINT_STRENGTH   "strength"

### NMAccessPoint

    typedef struct _NMAccessPoint NMAccessPoint;

### nm_access_point_new ()

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

Creates a new NMAccessPoint.

`connection` : | the DBusGConnection
`path` : | the DBusobject path of the access point
Returns : | a new access point

### nm_access_point_get_flags ()

    guint32             nm_access_point_get_flags           (NMAccessPoint *ap);

Gets the flags of the access point

`ap` : | a NMAccessPoint
Returns : | the flags

### nm_access_point_get_wpa_flags ()

    guint32             nm_access_point_get_wpa_flags       (NMAccessPoint *ap);

Gets the WPA flags of the access point.

`ap` : | a NMAccessPoint
Returns : | the WPA flags

### nm_access_point_get_rsn_flags ()

    guint32             nm_access_point_get_rsn_flags       (NMAccessPoint *ap);

Gets the RSN flags of the access point.

`ap` : | a NMAccessPoint
Returns : | the RSN flags

### nm_access_point_get_ssid ()

    const GByteArray *  nm_access_point_get_ssid            (NMAccessPoint *ap);

Gets the SSID of the access point.

`ap` : | a NMAccessPoint
Returns : | the GByteArray containing the SSID. This is the internal copy used by the access point, and must not be modified.

### nm_access_point_get_frequency ()

    guint32             nm_access_point_get_frequency       (NMAccessPoint *ap);

Gets the frequency of the access point.

`ap` : | a NMAccessPoint
Returns : | the frequency

### nm_access_point_get_hw_address ()

    const char *        nm_access_point_get_hw_address      (NMAccessPoint *ap);

Gets the hardware (MAC) address of the access point.

`ap` : | a NMAccessPoint
Returns : | the hardware address of the access point. This is the internal string used by the access point and must not be modified.

### nm_access_point_get_mode ()

    NM80211Mode         nm_access_point_get_mode            (NMAccessPoint *ap);

Gets the mode of the access point.

`ap` : | a NMAccessPoint
Returns : | the mode

### nm_access_point_get_max_bitrate ()

    guint32             nm_access_point_get_max_bitrate     (NMAccessPoint *ap);

Gets the maximum bit rate of the access point.

`ap` : | a NMAccessPoint
Returns : | the maximum bit rate

### nm_access_point_get_strength ()

    guint8              nm_access_point_get_strength        (NMAccessPoint *ap);

Gets the current signal strength of the access point.

`ap` : | a NMAccessPoint
Returns : | the signal strength

## Property Details

### The `"flags"` property

      "flags"                    guint                 : Read

The flags of the access point.

Allowed values: <= 1

Default value: 0

### The `"frequency"` property

      "frequency"                guint                 : Read

The frequency of the access point.

Allowed values: <= 10000

Default value: 0

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

      "hw-address"               gchar*                : Read

The hardware address of the access point.

Default value: NULL

### The `"max-bitrate"` property

      "max-bitrate"              guint                 : Read

The maximum bit rate of the access point.

Default value: 0

### The `"mode"` property

      "mode"                     guint                 : Read

The mode of the access point.

Allowed values: [1,2]

Default value: 2

### The `"rsn-flags"` property

      "rsn-flags"                guint                 : Read

The RSN flags of the access point.

Default value: 0

### The `"ssid"` property

      "ssid"                     nm-ssid*              : Read

The SSID of the access point.

### The `"strength"` property

      "strength"                 guchar                : Read

The current signal strength of the access point.

Default value: 0

### The `"wpa-flags"` property

      "wpa-flags"                guint                 : Read

The WPA flags of the access point.

Default value: 0