diff options
Diffstat (limited to 'docs/libnm-glib/html/NMAccessPoint.html')
| -rw-r--r-- | docs/libnm-glib/html/NMAccessPoint.html | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/libnm-glib/html/NMAccessPoint.html b/docs/libnm-glib/html/NMAccessPoint.html index 57efc51f..4b43358c 100644 --- a/docs/libnm-glib/html/NMAccessPoint.html +++ b/docs/libnm-glib/html/NMAccessPoint.html @@ -27,6 +27,8 @@ | <a href="#NMAccessPoint.object-hierarchy" class="shortcut">Object Hierarchy</a> | + <a href="#NMAccessPoint.implemented-interfaces" class="shortcut">Implemented Interfaces</a> + | <a href="#NMAccessPoint.properties" class="shortcut">Properties</a> </td></tr> </table> @@ -80,6 +82,12 @@ const <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.htm </pre> </div> <div class="refsect1"> +<a name="NMAccessPoint.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +NMAccessPoint implements + <a href="http://library.gnome.org/devel/gio/unstable/GInitable.html">GInitable</a> and <a href="http://library.gnome.org/devel/gio/unstable/GAsyncInitable.html">GAsyncInitable</a>.</p> +</div> +<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 @@ -211,7 +219,31 @@ const <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.htm <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> +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"> +<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 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> +<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"> @@ -224,6 +256,12 @@ 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> +<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"> <col align="left" valign="top"> <tbody> |