User Tools

Site Tools


listwifinetworks

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
listwifinetworks [2016/09/19 15:15]
act created
listwifinetworks [2016/09/20 09:29]
act
Line 1: Line 1:
-====== ListWifiNetworks ====== +====== ListWifiNetworks ​(since 1.0.1) ​====== 
-The ''​ListWifiNetworks''​ function returns a list Wifi network names. On Windows the names are the Wifi network profile names. On all other platforms the SSIDs are returned.+The ''​ListWifiNetworks''​ function returns a list of Wifi network names. On Windows ​and Linux the names are the Wifi network profile names. On all other platforms the SSIDs are returned. 
 + 
 +<WRAP center round important 60%> 
 +**Note:** Please read the platform restrictions described [[wifiscriptingfunctions|here]] first. 
 +</​WRAP>​
  
 ==== Parameters ==== ==== Parameters ====
-  * ''​networkInterface'':​ The network interface which is used to scan the networks. This argument is only required on Linux platforms. A common interface name is "​**wlan0**"​.+  * ''​networkInterface'':​ The network interface which is used to scan for networks. A common interface name is "​**wlan0**"​. At the moment this parameter is ignored on all platforms.
  
 ==== Syntax ==== ==== Syntax ====
Line 13: Line 17:
 <​code>​ <​code>​
 var result = ListWifiNetworks();​ var result = ListWifiNetworks();​
-// returns a list with Wifi networks. On Windows these are the profile names. +// returns a list with Wifi networks.
-// On all other platforms the SSIDs are returned.+
 // False is returned if the command failed, for instance if the network interface is // False is returned if the command failed, for instance if the network interface is
 // down or if no network interface is given but one is required by the platform. // down or if no network interface is given but one is required by the platform.
  
 var result = ListWifiNetworks("​wlan0"​);​ var result = ListWifiNetworks("​wlan0"​);​
-// returns a list of Wifi networks for the "​wlan0"​ interface.+// returns a list of Wifi networks for the "​wlan0"​ interface ​on platforms which support this.
 </​code>​ </​code>​
  
listwifinetworks.txt · Last modified: 2016/09/20 09:29 by act