diff options
Diffstat (limited to 'docs/libnm/html/NMDeviceWifi.html')
| -rw-r--r-- | docs/libnm/html/NMDeviceWifi.html | 141 |
1 files changed, 138 insertions, 3 deletions
diff --git a/docs/libnm/html/NMDeviceWifi.html b/docs/libnm/html/NMDeviceWifi.html index db0dca479..776aba148 100644 --- a/docs/libnm/html/NMDeviceWifi.html +++ b/docs/libnm/html/NMDeviceWifi.html @@ -113,6 +113,14 @@ </tr> <tr> <td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="NMDeviceWifi.html#nm-device-wifi-request-scan-options" title="nm_device_wifi_request_scan_options ()">nm_device_wifi_request_scan_options</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> <span class="returnvalue">void</span> </td> <td class="function_name"> @@ -121,6 +129,14 @@ </tr> <tr> <td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="NMDeviceWifi.html#nm-device-wifi-request-scan-options-async" title="nm_device_wifi_request_scan_options_async ()">nm_device_wifi_request_scan_options_async</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> <span class="returnvalue">gboolean</span> </td> <td class="function_name"> @@ -527,6 +543,64 @@ set.</p> </div> <hr> <div class="refsect2"> +<a name="nm-device-wifi-request-scan-options"></a><h3>nm_device_wifi_request_scan_options ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +nm_device_wifi_request_scan_options (<em class="parameter"><code><a class="link" href="NMDeviceWifi.html" title="NMDeviceWifi"><span class="type">NMDeviceWifi</span></a> *device</code></em>, + <em class="parameter"><code><span class="type">GVariant</span> *options</code></em>, + <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, + <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> +<p>Request NM to scan for access points on <em class="parameter"><code>device</code></em> +. Note that the function +returns immediately after requesting the scan, and it may take some time +after that for the scan to complete. +This is the same as <em class="parameter"><code>nm_device_wifi_request_scan</code></em> + except it accepts <em class="parameter"><code>options</code></em> + +for the scanning. The argument is the dictionary passed to <code class="function">RequestScan()</code> +D-Bus call. Valid otions inside the dictionary are: +'ssids' => array of SSIDs (saay)</p> +<div class="refsect3"> +<a name="id-1.5.14.9.11.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMDeviceWifi.html" title="NMDeviceWifi"><span class="type">NMDeviceWifi</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>options</p></td> +<td class="parameter_description"><p>dictionary with options for <code class="function">RequestScan()</code>, or <code class="literal">NULL</code></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p>a <span class="type">GCancellable</span>, or <code class="literal">NULL</code></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.5.14.9.11.6"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on error, in which case <em class="parameter"><code>error</code></em> +will be +set.</p> +</div> +<p class="since">Since: 1.0.6</p> +</div> +<hr> +<div class="refsect2"> <a name="nm-device-wifi-request-scan-async"></a><h3>nm_device_wifi_request_scan_async ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> nm_device_wifi_request_scan_async (<em class="parameter"><code><a class="link" href="NMDeviceWifi.html" title="NMDeviceWifi"><span class="type">NMDeviceWifi</span></a> *device</code></em>, @@ -539,7 +613,7 @@ nm_device_wifi_request_scan_async (<em class="parameter"><code><a class="link" h called immediately after requesting the scan, and it may take some time after that for the scan to complete.</p> <div class="refsect3"> -<a name="id-1.5.14.9.11.5"></a><h4>Parameters</h4> +<a name="id-1.5.14.9.12.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -574,6 +648,67 @@ that for the scan to complete.</p> </div> <hr> <div class="refsect2"> +<a name="nm-device-wifi-request-scan-options-async"></a><h3>nm_device_wifi_request_scan_options_async ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +nm_device_wifi_request_scan_options_async + (<em class="parameter"><code><a class="link" href="NMDeviceWifi.html" title="NMDeviceWifi"><span class="type">NMDeviceWifi</span></a> *device</code></em>, + <em class="parameter"><code><span class="type">GVariant</span> *options</code></em>, + <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, + <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> +<p>Request NM to scan for access points on <em class="parameter"><code>device</code></em> +. Note that <em class="parameter"><code>callback</code></em> + will be +called immediately after requesting the scan, and it may take some time after +that for the scan to complete. +This is the same as <em class="parameter"><code>nm_device_wifi_request_scan_async</code></em> + except it accepts <em class="parameter"><code>options</code></em> + +for the scanning. The argument is the dictionary passed to <code class="function">RequestScan()</code> +D-Bus call. Valid otions inside the dictionary are: +'ssids' => array of SSIDs (saay)</p> +<div class="refsect3"> +<a name="id-1.5.14.9.13.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMDeviceWifi.html" title="NMDeviceWifi"><span class="type">NMDeviceWifi</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>options</p></td> +<td class="parameter_description"><p>dictionary with options for <code class="function">RequestScan()</code>, or <code class="literal">NULL</code></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p>a <span class="type">GCancellable</span>, or <code class="literal">NULL</code></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p>callback to be called when the scan has been requested</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>caller-specific data passed to <em class="parameter"><code>callback</code></em> +</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 1.0.6</p> +</div> +<hr> +<div class="refsect2"> <a name="nm-device-wifi-request-scan-finish"></a><h3>nm_device_wifi_request_scan_finish ()</h3> <pre class="programlisting"><span class="returnvalue">gboolean</span> nm_device_wifi_request_scan_finish (<em class="parameter"><code><a class="link" href="NMDeviceWifi.html" title="NMDeviceWifi"><span class="type">NMDeviceWifi</span></a> *device</code></em>, @@ -581,7 +716,7 @@ nm_device_wifi_request_scan_finish (<em class="parameter"><code><a class="link" <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> <p>Gets the result of a call to <a class="link" href="NMDeviceWifi.html#nm-device-wifi-request-scan-async" title="nm_device_wifi_request_scan_async ()"><code class="function">nm_device_wifi_request_scan_async()</code></a>.</p> <div class="refsect3"> -<a name="id-1.5.14.9.12.5"></a><h4>Parameters</h4> +<a name="id-1.5.14.9.14.5"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -608,7 +743,7 @@ nm_device_wifi_request_scan_finish (<em class="parameter"><code><a class="link" </table></div> </div> <div class="refsect3"> -<a name="id-1.5.14.9.12.6"></a><h4>Returns</h4> +<a name="id-1.5.14.9.14.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on error, in which case <em class="parameter"><code>error</code></em> will be set.</p> |