Object Hierarchy

    GObject
+    GObject
     ╰── NMObject
         ╰── NMAccessPoint
 
@@ -292,8 +292,8 @@
 Functions
 
 nm_access_point_new ()
-GObject *
-nm_access_point_new (DBusGConnection *connection,
+GObject *
+nm_access_point_new (DBusGConnection *connection,
                      const char *path);
 Creates a new NMAccessPoint.
 
@@ -307,7 +307,7 @@ nm_access_point_new (connection
-the DBusGConnection
+the DBusGConnection
  
 
 
@@ -327,7 +327,7 @@ nm_access_point_new (
 nm_access_point_get_flags ()
-NM80211ApFlags
+NM80211ApFlags
 nm_access_point_get_flags (NMAccessPoint *ap);
 Gets the flags of the access point.
 
@@ -353,7 +353,7 @@ nm_access_point_get_flags (
 nm_access_point_get_wpa_flags ()
-NM80211ApSecurityFlags
+NM80211ApSecurityFlags
 nm_access_point_get_wpa_flags (NMAccessPoint *ap);
 Gets the WPA (version 1) flags of the access point.
 
@@ -379,7 +379,7 @@ nm_access_point_get_wpa_flags (
 
 nm_access_point_get_rsn_flags ()
-NM80211ApSecurityFlags
+NM80211ApSecurityFlags
 nm_access_point_get_rsn_flags (NMAccessPoint *ap);
 Gets the RSN (Robust Secure Network, ie WPA version 2) flags of the access
 point.
@@ -406,7 +406,7 @@ point.
 
 
 nm_access_point_get_ssid ()
-const GByteArray *
+const GByteArray *
 nm_access_point_get_ssid (NMAccessPoint *ap);
 Gets the SSID of the access point.
 
@@ -426,7 +426,7 @@ nm_access_point_get_ssid (
 Returns
- the GByteArray containing the SSID. This is the internal copy used by the
+
 the GByteArray containing the SSID. This is the internal copy used by the
 access point, and must not be modified.
 

 

@@ -460,9 +460,9 @@ not be modified or freed.
 
 
 nm_access_point_get_frequency ()
-guint32
+guint32
 nm_access_point_get_frequency (NMAccessPoint *ap);
-Gets the frequency of the access point.
+Gets the frequency of the access point in MHz.
 
 Parameters
 
@@ -480,13 +480,13 @@ nm_access_point_get_frequency (
 
 Returns
- the frequency
+ the frequency in MHz
 
 
 
 
 nm_access_point_get_mode ()
-NM80211Mode
+NM80211Mode
 nm_access_point_get_mode (NMAccessPoint *ap);
 Gets the mode of the access point.
 
@@ -512,7 +512,7 @@ nm_access_point_get_mode (
 nm_access_point_get_max_bitrate ()
-guint32
+guint32
 nm_access_point_get_max_bitrate (NMAccessPoint *ap);
 Gets the maximum bit rate of the access point in kbit/s.
 
@@ -538,9 +538,9 @@ nm_access_point_get_max_bitrate (
 
 nm_access_point_get_strength ()
-guint8
+guint8
 nm_access_point_get_strength (NMAccessPoint *ap);
-Gets the current signal strength of the access point.
+Gets the current signal strength of the access point as a percentage.
 
 Parameters
 

@@ -558,13 +558,13 @@ nm_access_point_get_strength (
 Returns
- the signal strength
+ the signal strength (0 to 100)
 
 
 
 
 nm_access_point_get_last_seen ()
-gint
+gint
 nm_access_point_get_last_seen (NMAccessPoint *ap);
 Returns the timestamp (in CLOCK_BOOTTIME seconds) for the last time the
 access point was found in scan results.  A value of -1 means the access
@@ -593,9 +593,9 @@ point has not been found in a scan.
 
 
 nm_access_point_filter_connections ()
-GSList *
+GSList *
 nm_access_point_filter_connections (NMAccessPoint *ap,
-                                    const GSList *connections);
+                                    const GSList *connections);
 Filters a given list of connections for a given NMAccessPoint object and
 return connections which may be activated with the access point.  Any
 returned connections will match the ap
@@ -622,7 +622,7 @@ filter that list with this function.
 
+NMConnection objects to filter. 
 
@@ -631,20 +631,20 @@ filter that list with this function.
 
 Returns
 a
-list of NMConnection objects that could be activated with the given ap
+list of NMConnection objects that could be activated with the given ap
 .
 The elements of the list are owned by their creator and should not be freed
 by the caller, but the returned list itself is owned by the caller and should
-be freed with g_slist_free() when it is no longer required. 
+be freed with g_slist_free() when it is no longer required. 
 [transfer container][element-type NMConnection]
 
 
 
 
 nm_access_point_connection_valid ()
-gboolean
+gboolean
 nm_access_point_connection_valid (NMAccessPoint *ap,
-                                  NMConnection *connection);
+                                  NMConnection *connection);
 Validates a given connection against a given Wi-Fi access point to ensure that
 the connection may be activated with that AP.  The connection must match the
 ap
@@ -667,7 +667,7 @@ against
 
 
-
@@ -676,8 +676,8 @@ against
 
 
 Returns
- TRUE if the connection may be activated with this Wi-Fi AP,
-FALSE if it cannot be.
+ TRUE if the connection may be activated with this Wi-Fi AP,
+FALSE if it cannot be.
 
 
 
@@ -784,7 +784,7 @@ access point and must not be modified.
 Property Details
 
 The “bssid” property
-  “bssid”                    gchar *
+  “bssid”                    gchar *
 The BSSID of the access point.
 Flags: Read
 Default value: NULL
@@ -792,7 +792,7 @@ access point and must not be modified.
 
 
 The “flags” property
-  “flags”                    guint
+  “flags”                    guint
 The flags of the access point.
 Flags: Read
 Allowed values: <= 1
@@ -801,7 +801,7 @@ access point and must not be modified.
 
 
 The “frequency” property
-  “frequency”                guint
+  “frequency”                guint
 The frequency of the access point.
 Flags: Read
 Allowed values: <= 10000
@@ -810,7 +810,7 @@ access point and must not be modified.
 
 
 The “hw-address” property
-  “hw-address”               gchar *
+  “hw-address”               gchar *
 The hardware address of the access point.
 Flags: Read
 Default value: NULL
@@ -818,7 +818,7 @@ access point and must not be modified.
 
 
 The “last-seen” property
-  “last-seen”                gint
+  “last-seen”                gint
 The timestamp (in CLOCK_BOOTTIME seconds) for the last time the
 access point was found in scan results.  A value of -1 means the
 access point has not been found in a scan.
@@ -830,7 +830,7 @@ access point has not been found in a scan.
 
 
 The “max-bitrate” property
-  “max-bitrate”              guint
+  “max-bitrate”              guint
 The maximum bit rate of the access point in kbit/s.
 Flags: Read
 Default value: 0
@@ -838,7 +838,7 @@ access point has not been found in a scan.
 
 
 The “mode” property
-  “mode”                     guint
+  “mode”                     guint
 The mode of the access point; either "infrastructure" (a central
 coordinator of the wireless network allowing clients to connect) or
 "ad-hoc" (a network with no central controller).
@@ -849,7 +849,7 @@ coordinator of the wireless network allowing clients to connect) or
 
 
 The “rsn-flags” property
-  “rsn-flags”                guint
+  “rsn-flags”                guint
 The RSN flags of the access point.
 Flags: Read
 Default value: 0
@@ -864,7 +864,7 @@ coordinator of the wireless network allowing clients to connect) or
 
 
 The “strength” property
-  “strength”                 guchar
+  “strength”                 guchar
 The current signal strength of the access point.
 Flags: Read
 Default value: 0
@@ -872,7 +872,7 @@ coordinator of the wireless network allowing clients to connect) or
 
 
 The “wpa-flags” property
-  “wpa-flags”                guint
+  “wpa-flags”                guint
 The WPA flags of the access point.
 Flags: Read
 Default value: 0
@@ -880,6 +880,6 @@ coordinator of the wireless network allowing clients to connect) or
 
 
 
-
Generated by GTK-Doc V1.27
+
Generated by GTK-Doc V1.28
 
 
\ No newline at end of file
-- 
cgit 1.3.0-6-gf8a5


 connections
 a list of
-NMConnection objects to filter. [element-type NMConnection]
 
 

 connection an NMConnection to validate against ap
+ an NMConnection to validate against ap

Object Hierarchy

Functions

nm_access_point_new ()

nm_access_point_get_flags ()

nm_access_point_get_wpa_flags ()

nm_access_point_get_rsn_flags ()

nm_access_point_get_ssid ()

Returns

nm_access_point_get_frequency ()

Parameters

Returns

nm_access_point_get_mode ()

nm_access_point_get_max_bitrate ()

nm_access_point_get_strength ()

Parameters

Returns

nm_access_point_get_last_seen ()

nm_access_point_filter_connections ()

Returns

nm_access_point_connection_valid ()

Returns

Property Details

The `“bssid”` property

The `“flags”` property

The `“frequency”` property

The `“hw-address”` property

The `“last-seen”` property

The `“max-bitrate”` property

The `“mode”` property

The `“rsn-flags”` property

The `“strength”` property

The `“wpa-flags”` property

connections	a list of -NMConnection objects to filter.	[element-type NMConnection]
connection	an NMConnection to validate against `ap` +	an NMConnection to validate against `ap`