Share via


NetworkOperatorTetheringManager.StartTetheringAsync Method

Definition

Overloads

StartTetheringAsync()

Establishes the tethering network.

We recommended that you first call StopTetheringAsync in order to ensure that the tethering hotspot is off.

StartTetheringAsync(NetworkOperatorTetheringSessionAccessPointConfiguration)

Starts the mobile hotspot using a specified per-session configuration.

This overload allows you to start a tethering session without having to pre-configure it via ConfigureAccessPointAsync. The configuration passed as a parameter is valid only for the current session, and will be lost once the session has ended.

Starting a new session via this overload of StartTetheringAsync also allows you to configure per-session-only parameters that can't be persistently set via ConfigureAccessPointAsync. Parameters that can be persisted are the network SSID, the network password, the network wireless frequency band, and the network authentication algorithm.

We recommended that you first call StopTetheringAsync in order to ensure that the tethering hotspot is off.

StartTetheringAsync()

Establishes the tethering network.

We recommended that you first call StopTetheringAsync in order to ensure that the tethering hotspot is off.

public:
 virtual IAsyncOperation<NetworkOperatorTetheringOperationResult ^> ^ StartTetheringAsync() = StartTetheringAsync;
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<NetworkOperatorTetheringOperationResult> StartTetheringAsync();
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<NetworkOperatorTetheringOperationResult> StartTetheringAsync();
function startTetheringAsync()
Public Function StartTetheringAsync () As IAsyncOperation(Of NetworkOperatorTetheringOperationResult)

Returns

The result of the tethering network operation.

Attributes

Windows requirements

App capabilities
wiFiControl

Applies to

StartTetheringAsync(NetworkOperatorTetheringSessionAccessPointConfiguration)

Starts the mobile hotspot using a specified per-session configuration.

This overload allows you to start a tethering session without having to pre-configure it via ConfigureAccessPointAsync. The configuration passed as a parameter is valid only for the current session, and will be lost once the session has ended.

Starting a new session via this overload of StartTetheringAsync also allows you to configure per-session-only parameters that can't be persistently set via ConfigureAccessPointAsync. Parameters that can be persisted are the network SSID, the network password, the network wireless frequency band, and the network authentication algorithm.

We recommended that you first call StopTetheringAsync in order to ensure that the tethering hotspot is off.

public:
 virtual IAsyncOperation<NetworkOperatorTetheringOperationResult ^> ^ StartTetheringAsync(NetworkOperatorTetheringSessionAccessPointConfiguration ^ configuration) = StartTetheringAsync;
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<NetworkOperatorTetheringOperationResult> StartTetheringAsync(NetworkOperatorTetheringSessionAccessPointConfiguration const& configuration);
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<NetworkOperatorTetheringOperationResult> StartTetheringAsync(NetworkOperatorTetheringSessionAccessPointConfiguration configuration);
function startTetheringAsync(configuration)
Public Function StartTetheringAsync (configuration As NetworkOperatorTetheringSessionAccessPointConfiguration) As IAsyncOperation(Of NetworkOperatorTetheringOperationResult)

Parameters

configuration
NetworkOperatorTetheringSessionAccessPointConfiguration

A NetworkOperatorTetheringSessionAccessPointConfiguration object containing all the per-session fields necessary to configure the mobile hotspot. This configuration doesn't persist between sessions.

Returns

An object containing a TetheringOperationStatus status code indicating whether the start operation was successful, or the reason of failure, as well as a detailed HSTRING containing an additional error message if applicable.

Attributes

Windows requirements

Device family
Windows 11, version 24H2 (introduced in 10.0.26100.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v19.0)
App capabilities
wiFiControl

Applies to