OobsIfaceWireless

OobsIfaceWireless — Object that represents an individual Wireless interface

Synopsis

                    OobsIfaceWireless;
const gchar*        oobs_iface_wireless_get_essid       (OobsIfaceWireless *iface);
void                oobs_iface_wireless_set_essid       (OobsIfaceWireless *iface,
                                                         const gchar *essid);
const gchar*        oobs_iface_wireless_get_key         (OobsIfaceWireless *iface);
void                oobs_iface_wireless_set_key         (OobsIfaceWireless *iface,
                                                         const gchar *key);
const gchar*        oobs_iface_wireless_get_key_type    (OobsIfaceWireless *iface);
void                oobs_iface_wireless_set_key_type    (OobsIfaceWireless *iface,
                                                         const gchar *key_type);

Object Hierarchy

  GObject
   +----OobsIface
         +----OobsIfaceEthernet
               +----OobsIfaceWireless

Properties

  "essid"                    gchar*                : Read / Write
  "key"                      gchar*                : Read / Write
  "key-type"                 gchar*                : Read / Write

Description

Details

OobsIfaceWireless

typedef struct _OobsIfaceWireless OobsIfaceWireless;

oobs_iface_wireless_get_essid ()

const gchar*        oobs_iface_wireless_get_essid       (OobsIfaceWireless *iface);

Returns the network identification (ESSID) that this interface uses.

iface :

 an OobsIfaceWireless.

Returns :

 A pointer to the network identification as a string. This string must not be freed, modified or stored.

oobs_iface_wireless_set_essid ()

void                oobs_iface_wireless_set_essid       (OobsIfaceWireless *iface,
                                                         const gchar *essid);

Sets a new network identification (ESSID), overwriting the previous one.

iface :

 An OobsIfaceWireless.

essid :

 a new ESSID for the interface.

oobs_iface_wireless_get_key ()

const gchar*        oobs_iface_wireless_get_key         (OobsIfaceWireless *iface);

Returns the network key associated to the ESSID that this interface uses.

iface :

 an OobsIfaceWireless.

Returns :

 A pointer to the network key as a string, or NULL if it's unset. This string must not be freed, modified or stored.

oobs_iface_wireless_set_key ()

void                oobs_iface_wireless_set_key         (OobsIfaceWireless *iface,
                                                         const gchar *key);

Sets a new network key for the ESSID that the interface uses.

iface :

 an OobsIfaceWireless.

key :

 a new key for the ESSID, or NULL to unset it.

oobs_iface_wireless_get_key_type ()

const gchar*        oobs_iface_wireless_get_key_type    (OobsIfaceWireless *iface);

Returns the type of key that the interface uses.

iface :

 an OobsIfaceWireless.

Returns :

 The key type.

oobs_iface_wireless_set_key_type ()

void                oobs_iface_wireless_set_key_type    (OobsIfaceWireless *iface,
                                                         const gchar *key_type);

Sets the type of the contained key.

iface :

 an OobsIfaceWireless.

key_type :

 a new type to define the key.

Property Details

The "essid" property

  "essid"                    gchar*                : Read / Write

ESSID.

Default value: NULL

The "key" property

  "key"                      gchar*                : Read / Write

Key.

Default value: NULL

The "key-type" property

  "key-type"                 gchar*                : Read / Write

key type.

Default value: NULL

See Also

OobsIface, OobsIfacesConfig, OobsIfaceEthernet, OobsIfaceIRLan, OobsIfacePlip, OobsIfacePPP, OobsIfaceWireless