diff options
Diffstat (limited to 'docs/libnm/html/NMAccessPoint.html')
| -rw-r--r-- | docs/libnm/html/NMAccessPoint.html | 74 |
1 files changed, 45 insertions, 29 deletions
diff --git a/docs/libnm/html/NMAccessPoint.html b/docs/libnm/html/NMAccessPoint.html index 2fbd6507..56a6c893 100644 --- a/docs/libnm/html/NMAccessPoint.html +++ b/docs/libnm/html/NMAccessPoint.html @@ -16,7 +16,8 @@ <td width="100%" align="left" class="shortcuts"> <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> <a href="#NMAccessPoint.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#NMAccessPoint.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#NMAccessPoint.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> + <a href="#NMAccessPoint.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> <a href="#NMAccessPoint.properties" class="shortcut">Properties</a></span> </td> <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> @@ -261,6 +262,10 @@ <td class="define_keyword">#define</td> <td class="function_name"><a class="link" href="NMAccessPoint.html#NM-ACCESS-POINT-HW-ADDRESS:CAPS" title="NM_ACCESS_POINT_HW_ADDRESS">NM_ACCESS_POINT_HW_ADDRESS</a></td> </tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="NMAccessPoint.html#NMAccessPoint-struct" title="NMAccessPoint">NMAccessPoint</a></td> +</tr> </tbody> </table></div> </div> @@ -272,6 +277,12 @@ </pre> </div> <div class="refsect1"> +<a name="NMAccessPoint.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +NMAccessPoint implements + GInitable and GAsyncInitable.</p> +</div> +<div class="refsect1"> <a name="NMAccessPoint.description"></a><h2>Description</h2> </div> <div class="refsect1"> @@ -282,7 +293,7 @@ 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.</p> <div class="refsect3"> -<a name="id-1.5.23.8.2.5"></a><h4>Parameters</h4> +<a name="id-1.5.23.9.2.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -297,7 +308,7 @@ nm_access_point_get_flags (<em class="parameter"><code><a class="link" href="NMA </table></div> </div> <div class="refsect3"> -<a name="id-1.5.23.8.2.6"></a><h4>Returns</h4> +<a name="id-1.5.23.9.2.6"></a><h4>Returns</h4> <p> the flags</p> </div> </div> @@ -308,7 +319,7 @@ nm_access_point_get_flags (<em class="parameter"><code><a class="link" href="NMA 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 (version 1) flags of the access point.</p> <div class="refsect3"> -<a name="id-1.5.23.8.3.5"></a><h4>Parameters</h4> +<a name="id-1.5.23.9.3.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -323,7 +334,7 @@ nm_access_point_get_wpa_flags (<em class="parameter"><code><a class="link" href= </table></div> </div> <div class="refsect3"> -<a name="id-1.5.23.8.3.6"></a><h4>Returns</h4> +<a name="id-1.5.23.9.3.6"></a><h4>Returns</h4> <p> the WPA flags</p> </div> </div> @@ -335,7 +346,7 @@ nm_access_point_get_rsn_flags (<em class="parameter"><code><a class="link" href= <p>Gets the RSN (Robust Secure Network, ie WPA version 2) flags of the access point.</p> <div class="refsect3"> -<a name="id-1.5.23.8.4.5"></a><h4>Parameters</h4> +<a name="id-1.5.23.9.4.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -350,7 +361,7 @@ point.</p> </table></div> </div> <div class="refsect3"> -<a name="id-1.5.23.8.4.6"></a><h4>Returns</h4> +<a name="id-1.5.23.9.4.6"></a><h4>Returns</h4> <p> the RSN flags</p> </div> </div> @@ -361,7 +372,7 @@ point.</p> 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> <div class="refsect3"> -<a name="id-1.5.23.8.5.5"></a><h4>Parameters</h4> +<a name="id-1.5.23.9.5.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -376,7 +387,7 @@ nm_access_point_get_ssid (<em class="parameter"><code><a class="link" href="NMAc </table></div> </div> <div class="refsect3"> -<a name="id-1.5.23.8.5.6"></a><h4>Returns</h4> +<a name="id-1.5.23.9.5.6"></a><h4>Returns</h4> <p> the <span class="type">GBytes</span> containing the SSID, or <code class="literal">NULL</code> if the SSID is unknown. </p> <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> @@ -389,7 +400,7 @@ SSID is unknown. </p> 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 Basic Service Set ID (BSSID) of the Wi-Fi access point.</p> <div class="refsect3"> -<a name="id-1.5.23.8.6.5"></a><h4>Parameters</h4> +<a name="id-1.5.23.9.6.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -404,7 +415,7 @@ nm_access_point_get_bssid (<em class="parameter"><code><a class="link" href="NMA </table></div> </div> <div class="refsect3"> -<a name="id-1.5.23.8.6.6"></a><h4>Returns</h4> +<a name="id-1.5.23.9.6.6"></a><h4>Returns</h4> <p> the BSSID of the access point. This is an internal string and must not be modified or freed.</p> </div> @@ -416,7 +427,7 @@ not be modified or freed.</p> 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 frequency of the access point.</p> <div class="refsect3"> -<a name="id-1.5.23.8.7.5"></a><h4>Parameters</h4> +<a name="id-1.5.23.9.7.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -431,7 +442,7 @@ nm_access_point_get_frequency (<em class="parameter"><code><a class="link" href= </table></div> </div> <div class="refsect3"> -<a name="id-1.5.23.8.7.6"></a><h4>Returns</h4> +<a name="id-1.5.23.9.7.6"></a><h4>Returns</h4> <p> the frequency</p> </div> </div> @@ -442,7 +453,7 @@ nm_access_point_get_frequency (<em class="parameter"><code><a class="link" href= 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>Gets the mode of the access point.</p> <div class="refsect3"> -<a name="id-1.5.23.8.8.5"></a><h4>Parameters</h4> +<a name="id-1.5.23.9.8.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -457,7 +468,7 @@ nm_access_point_get_mode (<em class="parameter"><code><a class="link" href="NMAc </table></div> </div> <div class="refsect3"> -<a name="id-1.5.23.8.8.6"></a><h4>Returns</h4> +<a name="id-1.5.23.9.8.6"></a><h4>Returns</h4> <p> the mode</p> </div> </div> @@ -468,7 +479,7 @@ nm_access_point_get_mode (<em class="parameter"><code><a class="link" href="NMAc 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 maximum bit rate of the access point in kbit/s.</p> <div class="refsect3"> -<a name="id-1.5.23.8.9.5"></a><h4>Parameters</h4> +<a name="id-1.5.23.9.9.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -483,7 +494,7 @@ nm_access_point_get_max_bitrate (<em class="parameter"><code><a class="link" hre </table></div> </div> <div class="refsect3"> -<a name="id-1.5.23.8.9.6"></a><h4>Returns</h4> +<a name="id-1.5.23.9.9.6"></a><h4>Returns</h4> <p> the maximum bit rate (kbit/s)</p> </div> </div> @@ -494,7 +505,7 @@ nm_access_point_get_max_bitrate (<em class="parameter"><code><a class="link" hre 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 current signal strength of the access point.</p> <div class="refsect3"> -<a name="id-1.5.23.8.10.5"></a><h4>Parameters</h4> +<a name="id-1.5.23.9.10.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -509,7 +520,7 @@ nm_access_point_get_strength (<em class="parameter"><code><a class="link" href=" </table></div> </div> <div class="refsect3"> -<a name="id-1.5.23.8.10.6"></a><h4>Returns</h4> +<a name="id-1.5.23.9.10.6"></a><h4>Returns</h4> <p> the signal strength</p> </div> </div> @@ -522,7 +533,7 @@ nm_access_point_get_last_seen (<em class="parameter"><code><a class="link" href= access point was found in scan results. A value of -1 means the access point has not been found in a scan.</p> <div class="refsect3"> -<a name="id-1.5.23.8.11.5"></a><h4>Parameters</h4> +<a name="id-1.5.23.9.11.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -537,7 +548,7 @@ point has not been found in a scan.</p> </table></div> </div> <div class="refsect3"> -<a name="id-1.5.23.8.11.6"></a><h4>Returns</h4> +<a name="id-1.5.23.9.11.6"></a><h4>Returns</h4> <p> the last seen time in seconds</p> </div> <p class="since">Since: 1.2</p> @@ -558,7 +569,7 @@ use <a class="link" href="NMClient.html#nm-client-get-connections" title="nm_cli <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="refsect3"> -<a name="id-1.5.23.8.12.6"></a><h4>Parameters</h4> +<a name="id-1.5.23.9.12.6"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -573,7 +584,7 @@ with this function.</p> </tr> <tr> <td class="parameter_name"><p>connections</p></td> -<td class="parameter_description"><p> an array of <a href="/usr/share/gtk-doc/html/libnm-util/NMConnection.html"><span class="type">NMConnections</span></a> to +<td class="parameter_description"><p> an array of <a href="NMConnection.html"><span class="type">NMConnections</span></a> to filter. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NMConnection]</span></td> </tr> @@ -581,9 +592,9 @@ filter. </p></td> </table></div> </div> <div class="refsect3"> -<a name="id-1.5.23.8.12.7"></a><h4>Returns</h4> +<a name="id-1.5.23.9.12.7"></a><h4>Returns</h4> <p> an array of -<a href="/usr/share/gtk-doc/html/libnm-util/NMConnection.html"><span class="type">NMConnections</span></a> that could be activated with the given <em class="parameter"><code>ap</code></em> +<a href="NMConnection.html"><span class="type">NMConnections</span></a> that could be activated with the given <em class="parameter"><code>ap</code></em> . The array should be freed with <code class="function">g_ptr_array_unref()</code> when it is no longer required. </p> <p><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> NMConnection]</span></p> @@ -594,14 +605,14 @@ be freed with <code class="function">g_ptr_array_unref()</code> when it is no lo <a name="nm-access-point-connection-valid"></a><h3>nm_access_point_connection_valid ()</h3> <pre class="programlisting"><span class="returnvalue">gboolean</span> 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="/usr/share/gtk-doc/html/libnm-util/NMConnection.html"><span class="type">NMConnection</span></a> *connection</code></em>);</pre> + <em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>);</pre> <p>Validates a given connection against a given Wi-Fi access point to ensure that the connection may be activated with that AP. The connection must match the <em class="parameter"><code>ap</code></em> 's SSID, (if given) BSSID, and other attributes like security settings, channel, band, etc.</p> <div class="refsect3"> -<a name="id-1.5.23.8.13.5"></a><h4>Parameters</h4> +<a name="id-1.5.23.9.13.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -617,7 +628,7 @@ against</p></td> </tr> <tr> <td class="parameter_name"><p>connection</p></td> -<td class="parameter_description"><p>an <a href="/usr/share/gtk-doc/html/libnm-util/NMConnection.html"><span class="type">NMConnection</span></a> to validate against <em class="parameter"><code>ap</code></em> +<td class="parameter_description"><p>an <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> to validate against <em class="parameter"><code>ap</code></em> </p></td> <td class="parameter_annotations"> </td> </tr> @@ -625,7 +636,7 @@ against</p></td> </table></div> </div> <div class="refsect3"> -<a name="id-1.5.23.8.13.6"></a><h4>Returns</h4> +<a name="id-1.5.23.9.13.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the connection may be activated with this Wi-Fi AP, <code class="literal">FALSE</code> if it cannot be.</p> </div> @@ -698,6 +709,11 @@ against</p></td> <pre class="programlisting">#define NM_ACCESS_POINT_HW_ADDRESS "hw-address" </pre> </div> +<hr> +<div class="refsect2"> +<a name="NMAccessPoint-struct"></a><h3>NMAccessPoint</h3> +<pre class="programlisting">typedef struct _NMAccessPoint NMAccessPoint;</pre> +</div> </div> <div class="refsect1"> <a name="NMAccessPoint.property-details"></a><h2>Property Details</h2> |