diff options
Diffstat (limited to 'docs/libnm-glib/html/NMAccessPoint.html')
| -rw-r--r-- | docs/libnm-glib/html/NMAccessPoint.html | 377 |
1 files changed, 208 insertions, 169 deletions
diff --git a/docs/libnm-glib/html/NMAccessPoint.html b/docs/libnm-glib/html/NMAccessPoint.html index a205b980..dfa604c6 100644 --- a/docs/libnm-glib/html/NMAccessPoint.html +++ b/docs/libnm-glib/html/NMAccessPoint.html @@ -3,12 +3,12 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>NMAccessPoint</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="libnm-glib Reference Manual"> <link rel="up" href="ch02.html" title="libnm-glib API Reference"> <link rel="prev" href="NMWimaxNsp.html" title="NMWimaxNsp"> <link rel="next" href="NMIP4Config.html" title="NMIP4Config"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -43,34 +43,34 @@ </tr></table></div> <div class="refsynopsisdiv"> <a name="NMAccessPoint.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> <a class="link" href="NMAccessPoint.html#NMAccessPoint-struct" title="NMAccessPoint">NMAccessPoint</a>; - <a class="link" href="NMAccessPoint.html#NMAccessPointClass" title="NMAccessPointClass">NMAccessPointClass</a>; +<pre class="synopsis">#define <a class="link" href="NMAccessPoint.html#NM-ACCESS-POINT-FLAGS:CAPS" title="NM_ACCESS_POINT_FLAGS">NM_ACCESS_POINT_FLAGS</a> +#define <a class="link" href="NMAccessPoint.html#NM-ACCESS-POINT-WPA-FLAGS:CAPS" title="NM_ACCESS_POINT_WPA_FLAGS">NM_ACCESS_POINT_WPA_FLAGS</a> +#define <a class="link" href="NMAccessPoint.html#NM-ACCESS-POINT-RSN-FLAGS:CAPS" title="NM_ACCESS_POINT_RSN_FLAGS">NM_ACCESS_POINT_RSN_FLAGS</a> +#define <a class="link" href="NMAccessPoint.html#NM-ACCESS-POINT-SSID:CAPS" title="NM_ACCESS_POINT_SSID">NM_ACCESS_POINT_SSID</a> #define <a class="link" href="NMAccessPoint.html#NM-ACCESS-POINT-BSSID:CAPS" title="NM_ACCESS_POINT_BSSID">NM_ACCESS_POINT_BSSID</a> -#define <a class="link" href="NMAccessPoint.html#NM-ACCESS-POINT-FLAGS:CAPS" title="NM_ACCESS_POINT_FLAGS">NM_ACCESS_POINT_FLAGS</a> #define <a class="link" href="NMAccessPoint.html#NM-ACCESS-POINT-FREQUENCY:CAPS" title="NM_ACCESS_POINT_FREQUENCY">NM_ACCESS_POINT_FREQUENCY</a> -#define <a class="link" href="NMAccessPoint.html#NM-ACCESS-POINT-HW-ADDRESS:CAPS" title="NM_ACCESS_POINT_HW_ADDRESS">NM_ACCESS_POINT_HW_ADDRESS</a> -#define <a class="link" href="NMAccessPoint.html#NM-ACCESS-POINT-MAX-BITRATE:CAPS" title="NM_ACCESS_POINT_MAX_BITRATE">NM_ACCESS_POINT_MAX_BITRATE</a> #define <a class="link" href="NMAccessPoint.html#NM-ACCESS-POINT-MODE:CAPS" title="NM_ACCESS_POINT_MODE">NM_ACCESS_POINT_MODE</a> -#define <a class="link" href="NMAccessPoint.html#NM-ACCESS-POINT-RSN-FLAGS:CAPS" title="NM_ACCESS_POINT_RSN_FLAGS">NM_ACCESS_POINT_RSN_FLAGS</a> -#define <a class="link" href="NMAccessPoint.html#NM-ACCESS-POINT-SSID:CAPS" title="NM_ACCESS_POINT_SSID">NM_ACCESS_POINT_SSID</a> +#define <a class="link" href="NMAccessPoint.html#NM-ACCESS-POINT-MAX-BITRATE:CAPS" title="NM_ACCESS_POINT_MAX_BITRATE">NM_ACCESS_POINT_MAX_BITRATE</a> #define <a class="link" href="NMAccessPoint.html#NM-ACCESS-POINT-STRENGTH:CAPS" title="NM_ACCESS_POINT_STRENGTH">NM_ACCESS_POINT_STRENGTH</a> -#define <a class="link" href="NMAccessPoint.html#NM-ACCESS-POINT-WPA-FLAGS:CAPS" title="NM_ACCESS_POINT_WPA_FLAGS">NM_ACCESS_POINT_WPA_FLAGS</a> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NMAccessPoint.html#nm-access-point-connection-valid" title="nm_access_point_connection_valid ()">nm_access_point_connection_valid</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>, - <em class="parameter"><code><a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/09/NMConnection.html"><span class="type">NMConnection</span></a> *connection</code></em>); -<a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * <a class="link" href="NMAccessPoint.html#nm-access-point-filter-connections" title="nm_access_point_filter_connections ()">nm_access_point_filter_connections</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>, - <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *connections</code></em>); -const <span class="returnvalue">char</span> * <a class="link" href="NMAccessPoint.html#nm-access-point-get-bssid" title="nm_access_point_get_bssid ()">nm_access_point_get_bssid</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>); +#define <a class="link" href="NMAccessPoint.html#NM-ACCESS-POINT-HW-ADDRESS:CAPS" title="NM_ACCESS_POINT_HW_ADDRESS">NM_ACCESS_POINT_HW_ADDRESS</a> + <a class="link" href="NMAccessPoint.html#NMAccessPoint-struct" title="NMAccessPoint">NMAccessPoint</a>; + <a class="link" href="NMAccessPoint.html#NMAccessPointClass" title="NMAccessPointClass">NMAccessPointClass</a>; +<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * <a class="link" href="NMAccessPoint.html#nm-access-point-new" title="nm_access_point_new ()">nm_access_point_new</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *connection</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *path</code></em>); <span class="returnvalue">NM80211ApFlags</span> <a class="link" href="NMAccessPoint.html#nm-access-point-get-flags" title="nm_access_point_get_flags ()">nm_access_point_get_flags</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>); -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="NMAccessPoint.html#nm-access-point-get-frequency" title="nm_access_point_get_frequency ()">nm_access_point_get_frequency</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>); -const <span class="returnvalue">char</span> * <a class="link" href="NMAccessPoint.html#nm-access-point-get-hw-address" title="nm_access_point_get_hw_address ()">nm_access_point_get_hw_address</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>); -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="NMAccessPoint.html#nm-access-point-get-max-bitrate" title="nm_access_point_get_max_bitrate ()">nm_access_point_get_max_bitrate</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>); -<span class="returnvalue">NM80211Mode</span> <a class="link" href="NMAccessPoint.html#nm-access-point-get-mode" title="nm_access_point_get_mode ()">nm_access_point_get_mode</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>); +<span class="returnvalue">NM80211ApSecurityFlags</span> <a class="link" href="NMAccessPoint.html#nm-access-point-get-wpa-flags" title="nm_access_point_get_wpa_flags ()">nm_access_point_get_wpa_flags</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>); <span class="returnvalue">NM80211ApSecurityFlags</span> <a class="link" href="NMAccessPoint.html#nm-access-point-get-rsn-flags" title="nm_access_point_get_rsn_flags ()">nm_access_point_get_rsn_flags</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>); const <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> * <a class="link" href="NMAccessPoint.html#nm-access-point-get-ssid" title="nm_access_point_get_ssid ()">nm_access_point_get_ssid</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMAccessPoint.html#nm-access-point-get-bssid" title="nm_access_point_get_bssid ()">nm_access_point_get_bssid</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="NMAccessPoint.html#nm-access-point-get-frequency" title="nm_access_point_get_frequency ()">nm_access_point_get_frequency</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>); +<span class="returnvalue">NM80211Mode</span> <a class="link" href="NMAccessPoint.html#nm-access-point-get-mode" title="nm_access_point_get_mode ()">nm_access_point_get_mode</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="NMAccessPoint.html#nm-access-point-get-max-bitrate" title="nm_access_point_get_max_bitrate ()">nm_access_point_get_max_bitrate</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>); <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="returnvalue">guint8</span></a> <a class="link" href="NMAccessPoint.html#nm-access-point-get-strength" title="nm_access_point_get_strength ()">nm_access_point_get_strength</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>); -<span class="returnvalue">NM80211ApSecurityFlags</span> <a class="link" href="NMAccessPoint.html#nm-access-point-get-wpa-flags" title="nm_access_point_get_wpa_flags ()">nm_access_point_get_wpa_flags</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>); -<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * <a class="link" href="NMAccessPoint.html#nm-access-point-new" title="nm_access_point_new ()">nm_access_point_new</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *connection</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *path</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * <a class="link" href="NMAccessPoint.html#nm-access-point-filter-connections" title="nm_access_point_filter_connections ()">nm_access_point_filter_connections</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *connections</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NMAccessPoint.html#nm-access-point-connection-valid" title="nm_access_point_connection_valid ()">nm_access_point_connection_valid</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>, + <em class="parameter"><code><a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/09/NMConnection.html"><span class="type">NMConnection</span></a> *connection</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMAccessPoint.html#nm-access-point-get-hw-address" title="nm_access_point_get_hw_address ()">nm_access_point_get_hw_address</a> (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>); </pre> </div> <div class="refsect1"> @@ -110,192 +110,177 @@ NMAccessPoint implements <div class="refsect1"> <a name="NMAccessPoint.details"></a><h2>Details</h2> <div class="refsect2"> -<a name="NMAccessPoint-struct"></a><h3>NMAccessPoint</h3> -<pre class="programlisting">typedef struct _NMAccessPoint NMAccessPoint;</pre> +<a name="NM-ACCESS-POINT-FLAGS:CAPS"></a><h3>NM_ACCESS_POINT_FLAGS</h3> +<pre class="programlisting">#define NM_ACCESS_POINT_FLAGS "flags" +</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="NMAccessPointClass"></a><h3>NMAccessPointClass</h3> -<pre class="programlisting">typedef struct { - NMObjectClass parent; - - /* Padding for future expansion */ - void (*_reserved1) (void); - void (*_reserved2) (void); - void (*_reserved3) (void); - void (*_reserved4) (void); - void (*_reserved5) (void); - void (*_reserved6) (void); -} NMAccessPointClass; +<a name="NM-ACCESS-POINT-WPA-FLAGS:CAPS"></a><h3>NM_ACCESS_POINT_WPA_FLAGS</h3> +<pre class="programlisting">#define NM_ACCESS_POINT_WPA_FLAGS "wpa-flags" </pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="NM-ACCESS-POINT-BSSID:CAPS"></a><h3>NM_ACCESS_POINT_BSSID</h3> -<pre class="programlisting">#define NM_ACCESS_POINT_BSSID "bssid" +<a name="NM-ACCESS-POINT-RSN-FLAGS:CAPS"></a><h3>NM_ACCESS_POINT_RSN_FLAGS</h3> +<pre class="programlisting">#define NM_ACCESS_POINT_RSN_FLAGS "rsn-flags" </pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="NM-ACCESS-POINT-FLAGS:CAPS"></a><h3>NM_ACCESS_POINT_FLAGS</h3> -<pre class="programlisting">#define NM_ACCESS_POINT_FLAGS "flags" +<a name="NM-ACCESS-POINT-SSID:CAPS"></a><h3>NM_ACCESS_POINT_SSID</h3> +<pre class="programlisting">#define NM_ACCESS_POINT_SSID "ssid" </pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="NM-ACCESS-POINT-FREQUENCY:CAPS"></a><h3>NM_ACCESS_POINT_FREQUENCY</h3> -<pre class="programlisting">#define NM_ACCESS_POINT_FREQUENCY "frequency" +<a name="NM-ACCESS-POINT-BSSID:CAPS"></a><h3>NM_ACCESS_POINT_BSSID</h3> +<pre class="programlisting">#define NM_ACCESS_POINT_BSSID "bssid" </pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="NM-ACCESS-POINT-HW-ADDRESS:CAPS"></a><h3>NM_ACCESS_POINT_HW_ADDRESS</h3> -<pre class="programlisting">#define NM_ACCESS_POINT_HW_ADDRESS "hw-address" +<a name="NM-ACCESS-POINT-FREQUENCY:CAPS"></a><h3>NM_ACCESS_POINT_FREQUENCY</h3> +<pre class="programlisting">#define NM_ACCESS_POINT_FREQUENCY "frequency" </pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="NM-ACCESS-POINT-MAX-BITRATE:CAPS"></a><h3>NM_ACCESS_POINT_MAX_BITRATE</h3> -<pre class="programlisting">#define NM_ACCESS_POINT_MAX_BITRATE "max-bitrate" +<a name="NM-ACCESS-POINT-MODE:CAPS"></a><h3>NM_ACCESS_POINT_MODE</h3> +<pre class="programlisting">#define NM_ACCESS_POINT_MODE "mode" </pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="NM-ACCESS-POINT-MODE:CAPS"></a><h3>NM_ACCESS_POINT_MODE</h3> -<pre class="programlisting">#define NM_ACCESS_POINT_MODE "mode" +<a name="NM-ACCESS-POINT-MAX-BITRATE:CAPS"></a><h3>NM_ACCESS_POINT_MAX_BITRATE</h3> +<pre class="programlisting">#define NM_ACCESS_POINT_MAX_BITRATE "max-bitrate" </pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="NM-ACCESS-POINT-RSN-FLAGS:CAPS"></a><h3>NM_ACCESS_POINT_RSN_FLAGS</h3> -<pre class="programlisting">#define NM_ACCESS_POINT_RSN_FLAGS "rsn-flags" +<a name="NM-ACCESS-POINT-STRENGTH:CAPS"></a><h3>NM_ACCESS_POINT_STRENGTH</h3> +<pre class="programlisting">#define NM_ACCESS_POINT_STRENGTH "strength" </pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="NM-ACCESS-POINT-SSID:CAPS"></a><h3>NM_ACCESS_POINT_SSID</h3> -<pre class="programlisting">#define NM_ACCESS_POINT_SSID "ssid" +<a name="NM-ACCESS-POINT-HW-ADDRESS:CAPS"></a><h3>NM_ACCESS_POINT_HW_ADDRESS</h3> +<pre class="programlisting">#define NM_ACCESS_POINT_HW_ADDRESS "hw-address" </pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="NM-ACCESS-POINT-STRENGTH:CAPS"></a><h3>NM_ACCESS_POINT_STRENGTH</h3> -<pre class="programlisting">#define NM_ACCESS_POINT_STRENGTH "strength" -</pre> +<a name="NMAccessPoint-struct"></a><h3>NMAccessPoint</h3> +<pre class="programlisting">typedef struct _NMAccessPoint NMAccessPoint;</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="NM-ACCESS-POINT-WPA-FLAGS:CAPS"></a><h3>NM_ACCESS_POINT_WPA_FLAGS</h3> -<pre class="programlisting">#define NM_ACCESS_POINT_WPA_FLAGS "wpa-flags" +<a name="NMAccessPointClass"></a><h3>NMAccessPointClass</h3> +<pre class="programlisting">typedef struct { + NMObjectClass parent; + + /* Padding for future expansion */ + void (*_reserved1) (void); + void (*_reserved2) (void); + void (*_reserved3) (void); + void (*_reserved4) (void); + void (*_reserved5) (void); + void (*_reserved6) (void); +} NMAccessPointClass; </pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="nm-access-point-connection-valid"></a><h3>nm_access_point_connection_valid ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_access_point_connection_valid (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>, - <em class="parameter"><code><a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/09/NMConnection.html"><span class="type">NMConnection</span></a> *connection</code></em>);</pre> +<a name="nm-access-point-new"></a><h3>nm_access_point_new ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * nm_access_point_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *connection</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre> <p> -Validates a given connection against a given WiFi access point to ensure that -the connection may be activated with that AP. The connection must match the -<em class="parameter"><code>ap</code></em>'s SSID, (if given) BSSID, and other attributes like security settings, -channel, band, etc. +Creates a new <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a>. </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>ap</code></em> :</span></p></td> -<td>an <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> to validate <em class="parameter"><code>connection</code></em> against</td> -</tr> -<tr> <td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>an <a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/09/NMConnection.html"><span class="type">NMConnection</span></a> to validate against <em class="parameter"><code>ap</code></em> +<td>the <a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> </td> </tr> <tr> +<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td> +<td>the DBusobject path of the access point</td> +</tr> +<tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the connection may be activated with this WiFi AP, -<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it cannot be.</td> +<td>a new access point. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2"> -<a name="nm-access-point-filter-connections"></a><h3>nm_access_point_filter_connections ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * nm_access_point_filter_connections (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>, - <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *connections</code></em>);</pre> -<p> -Filters a given list of connections for a given <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> object and -return connections which may be activated with the access point. Any -returned connections will match the <em class="parameter"><code>ap</code></em>'s SSID and (if given) BSSID and -other attributes like security settings, channel, etc. -</p> +<a name="nm-access-point-get-flags"></a><h3>nm_access_point_get_flags ()</h3> +<pre class="programlisting"><span class="returnvalue">NM80211ApFlags</span> nm_access_point_get_flags (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> <p> -To obtain the list of connections that are compatible with this access point, -use <a class="link" href="NMRemoteSettings.html#nm-remote-settings-list-connections" title="nm_remote_settings_list_connections ()"><code class="function">nm_remote_settings_list_connections()</code></a> and then filter the returned list -for a given <a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</span></a> using <a class="link" href="NMDevice.html#nm-device-filter-connections" title="nm_device_filter_connections ()"><code class="function">nm_device_filter_connections()</code></a> and finally -filter that list with this function. +Gets the flags of the access point. </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>ap</code></em> :</span></p></td> -<td>an <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> to filter connections for</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>connections</code></em> :</span></p></td> -<td>a list of -<a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/09/NMConnection.html"><span class="type">NMConnection</span></a> objects to filter. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NetworkManager.Connection]</span> +<td>a <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a -list of <a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/09/NMConnection.html"><span class="type">NMConnection</span></a> objects that could be activated with the given <em class="parameter"><code>ap</code></em>. -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 <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#g-slist-free"><code class="function">g_slist_free()</code></a> when it is no longer required. <span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NetworkManager.Connection]</span> -</td> +<td>the flags</td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2"> -<a name="nm-access-point-get-bssid"></a><h3>nm_access_point_get_bssid ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * nm_access_point_get_bssid (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> +<a name="nm-access-point-get-wpa-flags"></a><h3>nm_access_point_get_wpa_flags ()</h3> +<pre class="programlisting"><span class="returnvalue">NM80211ApSecurityFlags</span> nm_access_point_get_wpa_flags (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> <p> -Gets the Basic Service Set ID (BSSID) of the WiFi access point. +Gets the WPA (version 1) flags of the access point. </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>ap</code></em> :</span></p></td> @@ -304,21 +289,24 @@ Gets the Basic Service Set ID (BSSID) of the WiFi access point. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the BSSID of the access point. This is an internal string and must -not be modified or freed.</td> +<td>the WPA flags</td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2"> -<a name="nm-access-point-get-flags"></a><h3>nm_access_point_get_flags ()</h3> -<pre class="programlisting"><span class="returnvalue">NM80211ApFlags</span> nm_access_point_get_flags (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> +<a name="nm-access-point-get-rsn-flags"></a><h3>nm_access_point_get_rsn_flags ()</h3> +<pre class="programlisting"><span class="returnvalue">NM80211ApSecurityFlags</span> nm_access_point_get_rsn_flags (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> <p> -Gets the flags of the access point. +Gets the RSN (Robust Secure Network, ie WPA version 2) flags of the access +point. </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>ap</code></em> :</span></p></td> @@ -327,20 +315,23 @@ Gets the flags of the access point. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the flags</td> +<td>the RSN flags</td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2"> -<a name="nm-access-point-get-frequency"></a><h3>nm_access_point_get_frequency ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_access_point_get_frequency (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> +<a name="nm-access-point-get-ssid"></a><h3>nm_access_point_get_ssid ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> * nm_access_point_get_ssid (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> <p> -Gets the frequency of the access point. +Gets the SSID of the access point. </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>ap</code></em> :</span></p></td> @@ -349,24 +340,24 @@ Gets the frequency of the access point. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the frequency</td> +<td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GByteArray"><span class="type">GByteArray</span></a> containing the SSID. This is the internal copy used by the +access point, and must not be modified.</td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2"> -<a name="nm-access-point-get-hw-address"></a><h3>nm_access_point_get_hw_address ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * nm_access_point_get_hw_address (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> -<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"> -<h3 class="title">Warning</h3> -<p><code class="literal">nm_access_point_get_hw_address</code> has been deprecated since version 0.9 and should not be used in newly-written code. Use <a class="link" href="NMAccessPoint.html#nm-access-point-get-bssid" title="nm_access_point_get_bssid ()"><code class="function">nm_access_point_get_bssid()</code></a> instead.</p> -</div> +<a name="nm-access-point-get-bssid"></a><h3>nm_access_point_get_bssid ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_access_point_get_bssid (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> <p> -Gets the hardware (MAC) address of the access point. +Gets the Basic Service Set ID (BSSID) of the WiFi access point. </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>ap</code></em> :</span></p></td> @@ -375,21 +366,24 @@ Gets the hardware (MAC) address of the access point. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the hardware address of the access point. This is the internal string used by the -access point and must not be modified.</td> +<td>the BSSID of the access point. This is an internal string and must +not be modified or freed.</td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2"> -<a name="nm-access-point-get-max-bitrate"></a><h3>nm_access_point_get_max_bitrate ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_access_point_get_max_bitrate (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> +<a name="nm-access-point-get-frequency"></a><h3>nm_access_point_get_frequency ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_access_point_get_frequency (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> <p> -Gets the maximum bit rate of the access point. +Gets the frequency of the access point. </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>ap</code></em> :</span></p></td> @@ -398,7 +392,7 @@ Gets the maximum bit rate of the access point. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the maximum bit rate</td> +<td>the frequency</td> </tr> </tbody> </table></div> @@ -410,8 +404,11 @@ Gets the maximum bit rate of the access point. <p> Gets the mode of the access point. </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>ap</code></em> :</span></p></td> @@ -427,14 +424,16 @@ Gets the mode of the access point. </div> <hr> <div class="refsect2"> -<a name="nm-access-point-get-rsn-flags"></a><h3>nm_access_point_get_rsn_flags ()</h3> -<pre class="programlisting"><span class="returnvalue">NM80211ApSecurityFlags</span> nm_access_point_get_rsn_flags (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> +<a name="nm-access-point-get-max-bitrate"></a><h3>nm_access_point_get_max_bitrate ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_access_point_get_max_bitrate (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> <p> -Gets the RSN (Robust Secure Network, ie WPA version 2) flags of the access -point. +Gets the maximum bit rate of the access point. </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>ap</code></em> :</span></p></td> @@ -443,20 +442,23 @@ point. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the RSN flags</td> +<td>the maximum bit rate</td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2"> -<a name="nm-access-point-get-ssid"></a><h3>nm_access_point_get_ssid ()</h3> -<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> * nm_access_point_get_ssid (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> +<a name="nm-access-point-get-strength"></a><h3>nm_access_point_get_strength ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="returnvalue">guint8</span></a> nm_access_point_get_strength (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> <p> -Gets the SSID of the access point. +Gets the current signal strength of the access point. </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>ap</code></em> :</span></p></td> @@ -465,80 +467,117 @@ Gets the SSID of the access point. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GByteArray"><span class="type">GByteArray</span></a> containing the SSID. This is the internal copy used by the -access point, and must not be modified.</td> +<td>the signal strength</td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2"> -<a name="nm-access-point-get-strength"></a><h3>nm_access_point_get_strength ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="returnvalue">guint8</span></a> nm_access_point_get_strength (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> +<a name="nm-access-point-filter-connections"></a><h3>nm_access_point_filter_connections ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * nm_access_point_filter_connections (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *connections</code></em>);</pre> <p> -Gets the current signal strength of the access point. +Filters a given list of connections for a given <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> object and +return connections which may be activated with the access point. Any +returned connections will match the <em class="parameter"><code>ap</code></em>'s SSID and (if given) BSSID and +other attributes like security settings, channel, etc. </p> -<div class="variablelist"><table border="0"> +<p> +To obtain the list of connections that are compatible with this access point, +use <a class="link" href="NMRemoteSettings.html#nm-remote-settings-list-connections" title="nm_remote_settings_list_connections ()"><code class="function">nm_remote_settings_list_connections()</code></a> and then filter the returned list +for a given <a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</span></a> using <a class="link" href="NMDevice.html#nm-device-filter-connections" title="nm_device_filter_connections ()"><code class="function">nm_device_filter_connections()</code></a> and finally +filter that list with this function. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>ap</code></em> :</span></p></td> -<td>a <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> +<td>an <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> to filter connections for</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>connections</code></em> :</span></p></td> +<td>a list of +<a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/09/NMConnection.html"><span class="type">NMConnection</span></a> objects to filter. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NetworkManager.Connection]</span> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the signal strength</td> +<td>a +list of <a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/09/NMConnection.html"><span class="type">NMConnection</span></a> objects that could be activated with the given <em class="parameter"><code>ap</code></em>. +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 <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#g-slist-free"><code class="function">g_slist_free()</code></a> when it is no longer required. <span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NetworkManager.Connection]</span> +</td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2"> -<a name="nm-access-point-get-wpa-flags"></a><h3>nm_access_point_get_wpa_flags ()</h3> -<pre class="programlisting"><span class="returnvalue">NM80211ApSecurityFlags</span> nm_access_point_get_wpa_flags (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> +<a name="nm-access-point-connection-valid"></a><h3>nm_access_point_connection_valid ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_access_point_connection_valid (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>, + <em class="parameter"><code><a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/09/NMConnection.html"><span class="type">NMConnection</span></a> *connection</code></em>);</pre> <p> -Gets the WPA (version 1) flags of the access point. +Validates a given connection against a given WiFi access point to ensure that +the connection may be activated with that AP. The connection must match the +<em class="parameter"><code>ap</code></em>'s SSID, (if given) BSSID, and other attributes like security settings, +channel, band, etc. </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>ap</code></em> :</span></p></td> -<td>a <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> +<td>an <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> to validate <em class="parameter"><code>connection</code></em> against</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> +<td>an <a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/09/NMConnection.html"><span class="type">NMConnection</span></a> to validate against <em class="parameter"><code>ap</code></em> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the WPA flags</td> +<td> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the connection may be activated with this WiFi AP, +<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it cannot be.</td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2"> -<a name="nm-access-point-new"></a><h3>nm_access_point_new ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * nm_access_point_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *connection</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre> +<a name="nm-access-point-get-hw-address"></a><h3>nm_access_point_get_hw_address ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_access_point_get_hw_address (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> +<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"> +<h3 class="title">Warning</h3> +<p><code class="literal">nm_access_point_get_hw_address</code> has been deprecated since version 0.9 and should not be used in newly-written code. Use <a class="link" href="NMAccessPoint.html#nm-access-point-get-bssid" title="nm_access_point_get_bssid ()"><code class="function">nm_access_point_get_bssid()</code></a> instead.</p> +</div> <p> -Creates a new <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a>. +Gets the hardware (MAC) address of the access point. </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>the <a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> +<td><p><span class="term"><em class="parameter"><code>ap</code></em> :</span></p></td> +<td>a <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td> -<td>the DBusobject path of the access point</td> -</tr> -<tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a new access point. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> -</td> +<td>the hardware address of the access point. This is the internal string used by the +access point and must not be modified.</td> </tr> </tbody> </table></div> @@ -643,6 +682,6 @@ The WPA flags of the access point. </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.18</div> + Generated by GTK-Doc V1.19</div> </body> </html> \ No newline at end of file |