WiFiOnDemandHotspotConnectStatus Enum

Definition

Namespace:

Windows.Devices.WiFi

Note

Some information relates to pre-released product, which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Important

This API will be affected by upcoming changes to operating system behavior, planned for fall 2024. For more info, see Changes to API behavior for Wi-Fi access and location.

Defines constants that specify the status of a connection to a hotspot network.

Note

If you want to use this API in a UWP app, and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.onDemandHotspotControl_8wekyb3d8bbwe (the On-Demand Network capability). For more info, see Custom capabilities.

The On-Demand Network capability will be made available only to app developers building end-to-end Wi-Fi hotspot scenarios between a tethering-capable hardware device and a Windows PC.

public enum class WiFiOnDemandHotspotConnectStatus

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 983040)]
enum class WiFiOnDemandHotspotConnectStatus

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 983040)]
public enum WiFiOnDemandHotspotConnectStatus

var value = Windows.Devices.WiFi.WiFiOnDemandHotspotConnectStatus.unspecifiedFailure

Public Enum WiFiOnDemandHotspotConnectStatus

Inheritance

Enum

WiFiOnDemandHotspotConnectStatus

Attributes

ContractVersionAttribute

Windows requirements

Device family	Windows 11 Insider Preview (introduced in 10.0.23504.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v15.0)
App capabilities	onDemandHotspotControl

Fields

Name	Value	Description
UnspecifiedFailure	0	Specifies that the connection failed in an unspecified way.
Success	1	Specifies that the connection succeeded.
AppTimedOut	2	Specifies that the connection timed out.
InvalidCredential	3	Specifies that the connection failed due to invalid credentials.
NetworkNotAvailable	4	Specifies that the connection failed due to the network not being available.
UnsupportedAuthenticationProtocol	5	Specifies that the connection failed due to the authentication protocol not being supported.
BluetoothConnectFailed	6	Specifies that the connection failed due to a Bluetooth connection failure.
BluetoothTransmissionError	7	Specifies that the connection failed due to a Bluetooth transmission error.
OperationCanceledByUser	8	Specifies that the connection failed because the user canceled it.
EntitlementCheckFailed	9	Specifies that the connection failed because the cellular customer isn't allowed to use the tethering feature based on their entitlement.
NoCellularSignal	10	Specifies that the connection failed due to no cellular signal.
CellularDataTurnedOff	11	Specifies that the connection failed due to cellular data being turned off.
WlanConnectFailed	12	Specifies that the connection failed due to a wireless local-area network (WLAN) failure.
WlanNotVisible	13	Specifies that the connection failed due to the wireless local-area network (WLAN) not being visible. The PC couldn't see the SSID specified by the WiFiOnDemandHotspotNetworkProperties.Ssid property.
AccessPointCannotConnect	14	Specifies that the connection failed for not being able to connect to the access point.
CellularConnectTimedOut	15	Specifies that the connection failed due to a cellular connection timeout.
RoamingNotAllowed	16	Specifies that the connection failed because roaming isn't allowed.
PairingRequired	17	Specifies that the connection failed because pairing is required.
DataLimitReached	18	Specifies that the connection failed due to the data limit being reached.