diff options
Diffstat (limited to 'docs/libnm/html/NMAccessPoint.html')
| -rw-r--r-- | docs/libnm/html/NMAccessPoint.html | 78 |
1 files changed, 39 insertions, 39 deletions
diff --git a/docs/libnm/html/NMAccessPoint.html b/docs/libnm/html/NMAccessPoint.html index b1469048..9155943d 100644 --- a/docs/libnm/html/NMAccessPoint.html +++ b/docs/libnm/html/NMAccessPoint.html @@ -67,7 +67,7 @@ </tr> <tr> <td class="function_type"> -<span class="returnvalue">GBytes</span> * +<a href="https://developer.gnome.org/glib/unstable/glib-Byte-Arrays.html#GBytes"><span class="returnvalue">GBytes</span></a> * </td> <td class="function_name"> <a class="link" href="NMAccessPoint.html#nm-access-point-get-ssid" title="nm_access_point_get_ssid ()">nm_access_point_get_ssid</a> <span class="c_punctuation">()</span> @@ -82,7 +82,7 @@ </tr> <tr> <td class="function_type"> -<span class="returnvalue">guint32</span> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> </td> <td class="function_name"> <a class="link" href="NMAccessPoint.html#nm-access-point-get-frequency" title="nm_access_point_get_frequency ()">nm_access_point_get_frequency</a> <span class="c_punctuation">()</span> @@ -98,7 +98,7 @@ </tr> <tr> <td class="function_type"> -<span class="returnvalue">guint32</span> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> </td> <td class="function_name"> <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> <span class="c_punctuation">()</span> @@ -106,7 +106,7 @@ </tr> <tr> <td class="function_type"> -<span class="returnvalue">guint8</span> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint8"><span class="returnvalue">guint8</span></a> </td> <td class="function_name"> <a class="link" href="NMAccessPoint.html#nm-access-point-get-strength" title="nm_access_point_get_strength ()">nm_access_point_get_strength</a> <span class="c_punctuation">()</span> @@ -114,7 +114,7 @@ </tr> <tr> <td class="function_type"> -<span class="returnvalue">gint</span> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> </td> <td class="function_name"> <a class="link" href="NMAccessPoint.html#nm-access-point-get-last-seen" title="nm_access_point_get_last_seen ()">nm_access_point_get_last_seen</a> <span class="c_punctuation">()</span> @@ -122,7 +122,7 @@ </tr> <tr> <td class="function_type"> -<span class="returnvalue">GPtrArray</span> * +<a href="https://developer.gnome.org/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * </td> <td class="function_name"> <a class="link" href="NMAccessPoint.html#nm-access-point-filter-connections" title="nm_access_point_filter_connections ()">nm_access_point_filter_connections</a> <span class="c_punctuation">()</span> @@ -130,7 +130,7 @@ </tr> <tr> <td class="function_type"> -<span class="returnvalue">gboolean</span> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> </td> <td class="function_name"> <a class="link" href="NMAccessPoint.html#nm-access-point-connection-valid" title="nm_access_point_connection_valid ()">nm_access_point_connection_valid</a> <span class="c_punctuation">()</span> @@ -150,7 +150,7 @@ <tbody> <tr> <td class="property_type"> -<span class="type">gchar</span> *</td> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> <td class="property_name"><a class="link" href="NMAccessPoint.html#NMAccessPoint--bssid" title="The “bssid” property">bssid</a></td> <td class="property_flags">Read</td> </tr> @@ -160,23 +160,23 @@ <td class="property_flags">Read</td> </tr> <tr> -<td class="property_type"><span class="type">guint</span></td> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> <td class="property_name"><a class="link" href="NMAccessPoint.html#NMAccessPoint--frequency" title="The “frequency” property">frequency</a></td> <td class="property_flags">Read</td> </tr> <tr> <td class="property_type"> -<span class="type">gchar</span> *</td> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> <td class="property_name"><a class="link" href="NMAccessPoint.html#NMAccessPoint--hw-address" title="The “hw-address” property">hw-address</a></td> <td class="property_flags">Read</td> </tr> <tr> -<td class="property_type"><span class="type">gint</span></td> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> <td class="property_name"><a class="link" href="NMAccessPoint.html#NMAccessPoint--last-seen" title="The “last-seen” property">last-seen</a></td> <td class="property_flags">Read</td> </tr> <tr> -<td class="property_type"><span class="type">guint</span></td> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> <td class="property_name"><a class="link" href="NMAccessPoint.html#NMAccessPoint--max-bitrate" title="The “max-bitrate” property">max-bitrate</a></td> <td class="property_flags">Read</td> </tr> @@ -192,12 +192,12 @@ </tr> <tr> <td class="property_type"> -<span class="type">GBytes</span> *</td> +<a href="https://developer.gnome.org/glib/unstable/glib-Byte-Arrays.html#GBytes"><span class="type">GBytes</span></a> *</td> <td class="property_name"><a class="link" href="NMAccessPoint.html#NMAccessPoint--ssid" title="The “ssid” property">ssid</a></td> <td class="property_flags">Read</td> </tr> <tr> -<td class="property_type"><span class="type">guchar</span></td> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a></td> <td class="property_name"><a class="link" href="NMAccessPoint.html#NMAccessPoint--strength" title="The “strength” property">strength</a></td> <td class="property_flags">Read</td> </tr> @@ -266,7 +266,7 @@ </div> <div class="refsect1"> <a name="NMAccessPoint.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject +<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> <span class="lineart">╰──</span> <a class="link" href="NMObject.html" title="NMObject">NMObject</a> <span class="lineart">╰──</span> NMAccessPoint </pre> @@ -357,7 +357,7 @@ point.</p> <hr> <div class="refsect2"> <a name="nm-access-point-get-ssid"></a><h3>nm_access_point_get_ssid ()</h3> -<pre class="programlisting"><span class="returnvalue">GBytes</span> * +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Byte-Arrays.html#GBytes"><span class="returnvalue">GBytes</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> <div class="refsect3"> @@ -377,7 +377,7 @@ nm_access_point_get_ssid (<em class="parameter"><code><a class="link" href="NMAc </div> <div class="refsect3"> <a name="id-1.5.23.8.5.6"></a><h4>Returns</h4> -<p> the <span class="type">GBytes</span> containing the SSID, or <code class="literal">NULL</code> if the +<p> the <a href="https://developer.gnome.org/glib/unstable/glib-Byte-Arrays.html#GBytes"><span class="type">GBytes</span></a> containing the SSID, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> 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> </div> @@ -412,7 +412,7 @@ not be modified or freed.</p> <hr> <div class="refsect2"> <a name="nm-access-point-get-frequency"></a><h3>nm_access_point_get_frequency ()</h3> -<pre class="programlisting"><span class="returnvalue">guint32</span> +<pre class="programlisting"><a href="https://developer.gnome.org/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 frequency of the access point.</p> <div class="refsect3"> @@ -464,7 +464,7 @@ nm_access_point_get_mode (<em class="parameter"><code><a class="link" href="NMAc <hr> <div class="refsect2"> <a name="nm-access-point-get-max-bitrate"></a><h3>nm_access_point_get_max_bitrate ()</h3> -<pre class="programlisting"><span class="returnvalue">guint32</span> +<pre class="programlisting"><a href="https://developer.gnome.org/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 maximum bit rate of the access point in kbit/s.</p> <div class="refsect3"> @@ -490,7 +490,7 @@ nm_access_point_get_max_bitrate (<em class="parameter"><code><a class="link" hre <hr> <div class="refsect2"> <a name="nm-access-point-get-strength"></a><h3>nm_access_point_get_strength ()</h3> -<pre class="programlisting"><span class="returnvalue">guint8</span> +<pre class="programlisting"><a href="https://developer.gnome.org/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 current signal strength of the access point.</p> <div class="refsect3"> @@ -516,7 +516,7 @@ nm_access_point_get_strength (<em class="parameter"><code><a class="link" href=" <hr> <div class="refsect2"> <a name="nm-access-point-get-last-seen"></a><h3>nm_access_point_get_last_seen ()</h3> -<pre class="programlisting"><span class="returnvalue">gint</span> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> nm_access_point_get_last_seen (<em class="parameter"><code><a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *ap</code></em>);</pre> <p>Returns the timestamp (in CLOCK_BOOTTIME seconds) for the last time the access point was found in scan results. A value of -1 means the access @@ -545,9 +545,9 @@ point has not been found in a scan.</p> <hr> <div class="refsect2"> <a name="nm-access-point-filter-connections"></a><h3>nm_access_point_filter_connections ()</h3> -<pre class="programlisting"><span class="returnvalue">GPtrArray</span> * +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</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 <span class="type">GPtrArray</span> *connections</code></em>);</pre> + <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *connections</code></em>);</pre> <p>Filters a given array of connections for a given <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> object and returns connections which may be activated with the access point. Any returned connections will match the <em class="parameter"><code>ap</code></em> @@ -573,7 +573,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="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnections</span></a> to +<td class="parameter_description"><p> an array of <span class="type">NMConnections</span> 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> @@ -583,18 +583,18 @@ filter. </p></td> <div class="refsect3"> <a name="id-1.5.23.8.12.7"></a><h4>Returns</h4> <p> an array of -<a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnections</span></a> that could be activated with the given <em class="parameter"><code>ap</code></em> +<span class="type">NMConnections</span> 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> +be freed with <a href="https://developer.gnome.org/glib/unstable/glib-Pointer-Arrays.html#g-ptr-array-unref"><code class="function">g_ptr_array_unref()</code></a> 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> </div> </div> <hr> <div class="refsect2"> <a name="nm-access-point-connection-valid"></a><h3>nm_access_point_connection_valid ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> +<pre class="programlisting"><a href="https://developer.gnome.org/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="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> *connection</code></em>);</pre> + <em class="parameter"><code><span class="type">NMConnection</span> *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> @@ -617,7 +617,7 @@ against</p></td> </tr> <tr> <td class="parameter_name"><p>connection</p></td> -<td class="parameter_description"><p>an <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> to validate against <em class="parameter"><code>ap</code></em> +<td class="parameter_description"><p>an <span class="type">NMConnection</span> to validate against <em class="parameter"><code>ap</code></em> </p></td> <td class="parameter_annotations"> </td> </tr> @@ -626,8 +626,8 @@ against</p></td> </div> <div class="refsect3"> <a name="id-1.5.23.8.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> +<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the connection may be activated with this Wi-Fi AP, +<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it cannot be.</p> </div> </div> </div> @@ -703,7 +703,7 @@ against</p></td> <a name="NMAccessPoint.property-details"></a><h2>Property Details</h2> <div class="refsect2"> <a name="NMAccessPoint--bssid"></a><h3>The <code class="literal">“bssid”</code> property</h3> -<pre class="programlisting"> “bssid” <span class="type">gchar</span> *</pre> +<pre class="programlisting"> “bssid” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> <p>The BSSID of the access point.</p> <p>Flags: Read</p> <p>Default value: NULL</p> @@ -718,7 +718,7 @@ against</p></td> <hr> <div class="refsect2"> <a name="NMAccessPoint--frequency"></a><h3>The <code class="literal">“frequency”</code> property</h3> -<pre class="programlisting"> “frequency” <span class="type">guint</span></pre> +<pre class="programlisting"> “frequency” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> <p>The frequency of the access point.</p> <p>Flags: Read</p> <p>Allowed values: <= 10000</p> @@ -727,7 +727,7 @@ against</p></td> <hr> <div class="refsect2"> <a name="NMAccessPoint--hw-address"></a><h3>The <code class="literal">“hw-address”</code> property</h3> -<pre class="programlisting"> “hw-address” <span class="type">gchar</span> *</pre> +<pre class="programlisting"> “hw-address” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> <p>Alias for <a class="link" href="NMAccessPoint.html#NMAccessPoint--bssid" title="The “bssid” property"><span class="type">“bssid”</span></a>.</p> <div class="warning"> <p><code class="literal">NMAccessPoint:hw-address</code> has been deprecated since version 1.0 and should not be used in newly-written code.</p> @@ -739,7 +739,7 @@ against</p></td> <hr> <div class="refsect2"> <a name="NMAccessPoint--last-seen"></a><h3>The <code class="literal">“last-seen”</code> property</h3> -<pre class="programlisting"> “last-seen” <span class="type">gint</span></pre> +<pre class="programlisting"> “last-seen” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> <p>The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access point was found in scan results. A value of -1 means the access point has not been found in a scan.</p> @@ -751,7 +751,7 @@ access point has not been found in a scan.</p> <hr> <div class="refsect2"> <a name="NMAccessPoint--max-bitrate"></a><h3>The <code class="literal">“max-bitrate”</code> property</h3> -<pre class="programlisting"> “max-bitrate” <span class="type">guint</span></pre> +<pre class="programlisting"> “max-bitrate” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> <p>The maximum bit rate of the access point in kbit/s.</p> <p>Flags: Read</p> <p>Default value: 0</p> @@ -776,14 +776,14 @@ coordinator of the wireless network allowing clients to connect) or <hr> <div class="refsect2"> <a name="NMAccessPoint--ssid"></a><h3>The <code class="literal">“ssid”</code> property</h3> -<pre class="programlisting"> “ssid” <span class="type">GBytes</span> *</pre> -<p>The SSID of the access point, or <code class="literal">NULL</code> if it is not known.</p> +<pre class="programlisting"> “ssid” <a href="https://developer.gnome.org/glib/unstable/glib-Byte-Arrays.html#GBytes"><span class="type">GBytes</span></a> *</pre> +<p>The SSID of the access point, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if it is not known.</p> <p>Flags: Read</p> </div> <hr> <div class="refsect2"> <a name="NMAccessPoint--strength"></a><h3>The <code class="literal">“strength”</code> property</h3> -<pre class="programlisting"> “strength” <span class="type">guchar</span></pre> +<pre class="programlisting"> “strength” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a></pre> <p>The current signal strength of the access point.</p> <p>Flags: Read</p> <p>Default value: 0</p> |