diff options
Diffstat (limited to 'docs/libnm-glib/html/NMAccessPoint.html')
| -rw-r--r-- | docs/libnm-glib/html/NMAccessPoint.html | 268 |
1 files changed, 178 insertions, 90 deletions
diff --git a/docs/libnm-glib/html/NMAccessPoint.html b/docs/libnm-glib/html/NMAccessPoint.html index e26a0515..08cf78e8 100644 --- a/docs/libnm-glib/html/NMAccessPoint.html +++ b/docs/libnm-glib/html/NMAccessPoint.html @@ -5,17 +5,17 @@ <title>NMAccessPoint</title> <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> <link rel="home" href="index.html" title="libnm-glib Reference Manual"> -<link rel="up" href="ch01.html" title="libnm-glib Objects"> -<link rel="prev" href="NMDeviceBt.html" title="NMDeviceBt"> +<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.15 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> <tr valign="middle"> -<td><a accesskey="p" href="NMDeviceBt.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="NMWimaxNsp.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">libnm-glib Reference Manual</th> <td><a accesskey="n" href="NMIP4Config.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> @@ -30,7 +30,7 @@ <a href="#NMAccessPoint.properties" class="shortcut">Properties</a> </td></tr> </table> -<div class="refentry" title="NMAccessPoint"> +<div class="refentry"> <a name="NMAccessPoint"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> @@ -39,33 +39,40 @@ </td> <td valign="top" align="right"></td> </tr></table></div> -<div class="refsynopsisdiv" title="Synopsis"> +<div class="refsynopsisdiv"> <a name="NMAccessPoint.synopsis"></a><h2>Synopsis</h2> <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-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-MODE:CAPS" title="NM_ACCESS_POINT_MODE">NM_ACCESS_POINT_MODE</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-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>); -<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-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-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/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <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>); +<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>); +<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>); -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>); <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>); +<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><span class="type">NMConnection</span> *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" title="Object Hierarchy"> +<div class="refsect1"> <a name="NMAccessPoint.object-hierarchy"></a><h2>Object Hierarchy</h2> <pre class="synopsis"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> @@ -73,28 +80,29 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMAcc +----NMAccessPoint </pre> </div> -<div class="refsect1" title="Properties"> +<div class="refsect1"> <a name="NMAccessPoint.properties"></a><h2>Properties</h2> <pre class="synopsis"> + "<a class="link" href="NMAccessPoint.html#NMAccessPoint--bssid" title='The "bssid" property'>bssid</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read "<a class="link" href="NMAccessPoint.html#NMAccessPoint--flags" title='The "flags" property'>flags</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read "<a class="link" href="NMAccessPoint.html#NMAccessPoint--frequency" title='The "frequency" property'>frequency</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read "<a class="link" href="NMAccessPoint.html#NMAccessPoint--hw-address" title='The "hw-address" property'>hw-address</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read "<a class="link" href="NMAccessPoint.html#NMAccessPoint--max-bitrate" title='The "max-bitrate" property'>max-bitrate</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read "<a class="link" href="NMAccessPoint.html#NMAccessPoint--mode" title='The "mode" property'>mode</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read "<a class="link" href="NMAccessPoint.html#NMAccessPoint--rsn-flags" title='The "rsn-flags" property'>rsn-flags</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read - "<a class="link" href="NMAccessPoint.html#NMAccessPoint--ssid" title='The "ssid" property'>ssid</a>" <span class="type">nm-ssid*</span> : Read + "<a class="link" href="NMAccessPoint.html#NMAccessPoint--ssid" title='The "ssid" property'>ssid</a>" <span class="type">NMSsid</span>* : Read "<a class="link" href="NMAccessPoint.html#NMAccessPoint--strength" title='The "strength" property'>strength</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> : Read "<a class="link" href="NMAccessPoint.html#NMAccessPoint--wpa-flags" title='The "wpa-flags" property'>wpa-flags</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read </pre> </div> -<div class="refsect1" title="Description"> +<div class="refsect1"> <a name="NMAccessPoint.description"></a><h2>Description</h2> <p> </p> </div> -<div class="refsect1" title="Details"> +<div class="refsect1"> <a name="NMAccessPoint.details"></a><h2>Details</h2> -<div class="refsect2" title="NM_ACCESS_POINT_FLAGS"> +<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" </pre> @@ -102,7 +110,7 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMAcc </p> </div> <hr> -<div class="refsect2" title="NM_ACCESS_POINT_WPA_FLAGS"> +<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" </pre> @@ -110,7 +118,7 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMAcc </p> </div> <hr> -<div class="refsect2" title="NM_ACCESS_POINT_RSN_FLAGS"> +<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" </pre> @@ -118,7 +126,7 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMAcc </p> </div> <hr> -<div class="refsect2" title="NM_ACCESS_POINT_SSID"> +<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" </pre> @@ -126,23 +134,23 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMAcc </p> </div> <hr> -<div class="refsect2" title="NM_ACCESS_POINT_FREQUENCY"> -<a name="NM-ACCESS-POINT-FREQUENCY:CAPS"></a><h3>NM_ACCESS_POINT_FREQUENCY</h3> -<pre class="programlisting">#define NM_ACCESS_POINT_FREQUENCY "frequency" +<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" </pre> <p> </p> </div> <hr> -<div class="refsect2" title="NM_ACCESS_POINT_HW_ADDRESS"> -<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" +<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" </pre> <p> </p> </div> <hr> -<div class="refsect2" title="NM_ACCESS_POINT_MODE"> +<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" </pre> @@ -150,7 +158,7 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMAcc </p> </div> <hr> -<div class="refsect2" title="NM_ACCESS_POINT_MAX_BITRATE"> +<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" </pre> @@ -158,7 +166,7 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMAcc </p> </div> <hr> -<div class="refsect2" title="NM_ACCESS_POINT_STRENGTH"> +<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> @@ -166,14 +174,22 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMAcc </p> </div> <hr> -<div class="refsect2" title="NMAccessPoint"> +<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" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> <a name="NMAccessPoint-struct"></a><h3>NMAccessPoint</h3> <pre class="programlisting">typedef struct _NMAccessPoint NMAccessPoint;</pre> <p> </p> </div> <hr> -<div class="refsect2" title="NMAccessPointClass"> +<div class="refsect2"> <a name="NMAccessPointClass"></a><h3>NMAccessPointClass</h3> <pre class="programlisting">typedef struct { NMObjectClass parent; @@ -191,7 +207,7 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMAcc </p> </div> <hr> -<div class="refsect2" title="nm_access_point_new ()"> +<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> @@ -208,23 +224,22 @@ Creates a new <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><s </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> +<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 +<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" title="nm_access_point_get_flags ()"> +<div class="refsect2"> <a name="nm-access-point-get-flags"></a><h3>nm_access_point_get_flags ()</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_flags (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> +<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> -Gets the flags of the access point +Gets the flags of the access point. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -236,18 +251,17 @@ 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 flags</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2" title="nm_access_point_get_wpa_flags ()"> +<div class="refsect2"> <a name="nm-access-point-get-wpa-flags"></a><h3>nm_access_point_get_wpa_flags ()</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_wpa_flags (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> +<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 WPA flags of the access point. +Gets the WPA (version 1) flags of the access point. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -259,18 +273,18 @@ Gets the WPA flags of the access point. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the WPA flags -</td> +<td>the WPA flags</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2" title="nm_access_point_get_rsn_flags ()"> +<div class="refsect2"> <a name="nm-access-point-get-rsn-flags"></a><h3>nm_access_point_get_rsn_flags ()</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_rsn_flags (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> +<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 RSN 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"> <col align="left" valign="top"> @@ -282,16 +296,15 @@ Gets the RSN flags of the access 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 RSN flags</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2" title="nm_access_point_get_ssid ()"> +<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> +<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 SSID of the access point. </p> @@ -305,19 +318,18 @@ 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 <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" title="nm_access_point_get_frequency ()"> -<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> +<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> <p> -Gets the frequency of the access point. +Gets the Basic Service Set ID (BSSID) of the WiFi access point. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -329,18 +341,18 @@ 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 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" title="nm_access_point_get_hw_address ()"> -<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="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> <p> -Gets the hardware (MAC) address of the access point. +Gets the frequency of the access point. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -352,15 +364,13 @@ 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 frequency</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2" title="nm_access_point_get_mode ()"> +<div class="refsect2"> <a name="nm-access-point-get-mode"></a><h3>nm_access_point_get_mode ()</h3> <pre class="programlisting"><span class="returnvalue">NM80211Mode</span> nm_access_point_get_mode (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> <p> @@ -376,14 +386,13 @@ Gets the mode of the access point. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the mode -</td> +<td>the mode</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2" title="nm_access_point_get_max_bitrate ()"> +<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> <p> @@ -399,14 +408,13 @@ 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 maximum bit rate</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2" title="nm_access_point_get_strength ()"> +<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> <p> @@ -422,16 +430,96 @@ Gets the current signal strength of the access point. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the signal strength +<td>the signal strength</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> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<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 +<span class="type">NMConnection</span> 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>a +list of <span class="type">NMConnection</span> 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-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><span class="type">NMConnection</span> *connection</code></em>);</pre> +<p> +</p> +</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> -<div class="refsect1" title="Property Details"> +<p> +Gets the hardware (MAC) address of the access point. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<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> +</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> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> <a name="NMAccessPoint.property-details"></a><h2>Property Details</h2> -<div class="refsect2" title='The "flags" property'> +<div class="refsect2"> +<a name="NMAccessPoint--bssid"></a><h3>The <code class="literal">"bssid"</code> property</h3> +<pre class="programlisting"> "bssid" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre> +<p> +The BSSID of the access point. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> <a name="NMAccessPoint--flags"></a><h3>The <code class="literal">"flags"</code> property</h3> <pre class="programlisting"> "flags" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read</pre> <p> @@ -441,7 +529,7 @@ The flags of the access point. <p>Default value: 0</p> </div> <hr> -<div class="refsect2" title='The "frequency" property'> +<div class="refsect2"> <a name="NMAccessPoint--frequency"></a><h3>The <code class="literal">"frequency"</code> property</h3> <pre class="programlisting"> "frequency" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read</pre> <p> @@ -451,7 +539,7 @@ The frequency of the access point. <p>Default value: 0</p> </div> <hr> -<div class="refsect2" title='The "hw-address" property'> +<div class="refsect2"> <a name="NMAccessPoint--hw-address"></a><h3>The <code class="literal">"hw-address"</code> property</h3> <pre class="programlisting"> "hw-address" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre> <p> @@ -460,7 +548,7 @@ The hardware address of the access point. <p>Default value: NULL</p> </div> <hr> -<div class="refsect2" title='The "max-bitrate" property'> +<div class="refsect2"> <a name="NMAccessPoint--max-bitrate"></a><h3>The <code class="literal">"max-bitrate"</code> property</h3> <pre class="programlisting"> "max-bitrate" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read</pre> <p> @@ -469,7 +557,7 @@ The maximum bit rate of the access point. <p>Default value: 0</p> </div> <hr> -<div class="refsect2" title='The "mode" property'> +<div class="refsect2"> <a name="NMAccessPoint--mode"></a><h3>The <code class="literal">"mode"</code> property</h3> <pre class="programlisting"> "mode" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read</pre> <p> @@ -479,7 +567,7 @@ The mode of the access point. <p>Default value: 2</p> </div> <hr> -<div class="refsect2" title='The "rsn-flags" property'> +<div class="refsect2"> <a name="NMAccessPoint--rsn-flags"></a><h3>The <code class="literal">"rsn-flags"</code> property</h3> <pre class="programlisting"> "rsn-flags" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read</pre> <p> @@ -488,15 +576,15 @@ The RSN flags of the access point. <p>Default value: 0</p> </div> <hr> -<div class="refsect2" title='The "ssid" property'> +<div class="refsect2"> <a name="NMAccessPoint--ssid"></a><h3>The <code class="literal">"ssid"</code> property</h3> -<pre class="programlisting"> "ssid" <span class="type">nm-ssid*</span> : Read</pre> +<pre class="programlisting"> "ssid" <span class="type">NMSsid</span>* : Read</pre> <p> The SSID of the access point. </p> </div> <hr> -<div class="refsect2" title='The "strength" property'> +<div class="refsect2"> <a name="NMAccessPoint--strength"></a><h3>The <code class="literal">"strength"</code> property</h3> <pre class="programlisting"> "strength" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> : Read</pre> <p> @@ -505,7 +593,7 @@ The current signal strength of the access point. <p>Default value: 0</p> </div> <hr> -<div class="refsect2" title='The "wpa-flags" property'> +<div class="refsect2"> <a name="NMAccessPoint--wpa-flags"></a><h3>The <code class="literal">"wpa-flags"</code> property</h3> <pre class="programlisting"> "wpa-flags" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read</pre> <p> @@ -517,6 +605,6 @@ The WPA flags of the access point. </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.15</div> + Generated by GTK-Doc V1.17</div> </body> </html> \ No newline at end of file |