Table of Contents

Class WirelessAPConfiguration

Namespace
System.Net.NetworkInformation
Assembly
System.Net.dll

Configuration of wireless network SOft AP based on the 802.11 standard.

public class WirelessAPConfiguration
Inheritance
WirelessAPConfiguration
Inherited Members
Extension Methods

Remarks

This class is exclusive of nanoFramework and does not exist on the UWP API.

Constructors

WirelessAPConfiguration(uint)

Initializes a new instance of the WirelessAPConfiguration class.

public WirelessAPConfiguration(uint id)

Parameters

id uint

The ID of the wireless configuration.

Properties

Authentication

Specifies the type of authentication used for the wireless AP.

public AuthenticationType Authentication { get; set; }

Property Value

AuthenticationType

Channel

Channel to use for AP.

public byte Channel { get; set; }

Property Value

byte

Encryption

Specifies the type of encryption used for the wireless AP.

public EncryptionType Encryption { get; set; }

Property Value

EncryptionType

Id

Contains the ID of the wireless AP configuration.

public uint Id { get; }

Property Value

uint

MaxConnections

Maximum number of client connections

public byte MaxConnections { get; set; }

Property Value

byte

Options

Contains flags for the Soft AP

public WirelessAPConfiguration.ConfigurationOptions Options { get; set; }

Property Value

WirelessAPConfiguration.ConfigurationOptions

Password

Contains the network passphrase used for clients to connect to Soft AP

public string Password { get; set; }

Property Value

string

Radio

Specifies the type of radio used by the wireless network adapter.

public RadioType Radio { get; set; }

Property Value

RadioType

Ssid

Contains the Soft AP SSID.

public string Ssid { get; set; }

Property Value

string

Methods

DeAuthStation(int)

DeAuthorise a connected station

public void DeAuthStation(int stationIndex)

Parameters

stationIndex int

The index of station to De-Auth or 0 to De-Auth all stations.

GetAllWirelessAPConfigurations()

Retrieves an array of all of the wireless Soft AP network configurations.

public static WirelessAPConfiguration[] GetAllWirelessAPConfigurations()

Returns

WirelessAPConfiguration[]

An array containing all of the wireless 802.11 AP network configuration stored in the device.

GetConnectedStations()

Returns an array of information about the connected stations.

public WirelessAPStation[] GetConnectedStations()

Returns

WirelessAPStation[]

A WirelessAPStation

GetConnectedStations(int)

Returns information about the a connected station.

public WirelessAPStation GetConnectedStations(int stationIndex)

Parameters

stationIndex int

The index of station to get information about.

Returns

WirelessAPStation

An WirelessAPStation.

SaveConfiguration()

Validate and save the wireless Soft AP configuration information.

public void SaveConfiguration()

Remarks

Checks the length of SSID is 32 or less. Password length is between 8 and 64 if not an open Authentication. Max connections has to be greater than zero.

Exceptions

ArgumentOutOfRangeException

If MaxConnections is less than one.

ArgumentOutOfRangeException

If Password is less than 8 character or more than 64 characters and not open Authentication.

ArgumentOutOfRangeException

If Ssid is longer than System.Net.NetworkInformation.WirelessAPConfiguration.MaxApSsidLength

ArgumentNullException

If Ssid is null.