[PATCH] doc: update D-Bus docs for Scan()'s new AllowRoam option

Dan Williams dcbw at redhat.com
Tue Oct 22 15:28:39 EDT 2013


Signed-hostap: Dan Williams <dcbw at redhat.com>
---
 doc/dbus.doxygen | 1 +
 1 file changed, 1 insertion(+)

diff --git a/doc/dbus.doxygen b/doc/dbus.doxygen
index 1fa7a3a..7e4c7c9 100644
--- a/doc/dbus.doxygen
+++ b/doc/dbus.doxygen
@@ -183,14 +183,15 @@ fi.w1.wpa_supplicant1.CreateInterface.
 	    A dictionary with arguments describing scan type:
 	    <table>
 	      <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th>
 	      <tr><td>Type</td><td>s</td><td>Type of the scan. Possible values: "active", "passive"</td><td>Yes</td>
 	      <tr><td>SSIDs</td><td>aay</td><td>Array of SSIDs to scan for (applies only if scan type is active)</td><td>No</td>
 	      <tr><td>IEs</td><td>aay</td><td>Information elements to used in active scan (applies only if scan type is active)</td><td>No</td>
 	      <tr><td>Channels</td><td>a(uu)</td><td>Array of frequencies to scan in form of (center, width) in MHz.</td><td>No</td>
+	      <tr><td>AllowRoam</td><td>b</td><td>TRUE (or absent) to allow a roaming decision based on the results of this scan, FALSE to prevent a roaming decision.</td><td>No</td>
 	    </table>
 	  </dd>
 	</dl>
 	<h4>Possible errors</h4>
 	<dl>
 	  <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
 	  <dd>Invalid entries were found in the passed argument.</dd>
-- 
1.8.3.1




More information about the HostAP mailing list