VpnChannelConfiguration VpnChannelConfiguration VpnChannelConfiguration VpnChannelConfiguration Class

Definition

The configuration of the VpnChannel, which dictates how to establish the communication with the VPN server.

public : sealed class VpnChannelConfiguration : IVpnChannelConfiguration, IVpnChannelConfiguration2public sealed class VpnChannelConfiguration : IVpnChannelConfiguration, IVpnChannelConfiguration2Public NotInheritable Class VpnChannelConfiguration Implements IVpnChannelConfiguration, IVpnChannelConfiguration2// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

Properties

CustomField CustomField CustomField CustomField

Gets the custom configuration as a string which the VPN plug-in parses to configure VPN vendor specific settings. The field is a string to allow XML as the data format of the configuration.

public : PlatForm::String CustomField { get; }public string CustomField { get; }Public ReadOnly Property CustomField As string// This API is not available in Javascript.
Value
PlatForm::String string string string

The custom configuration string data which the VPN plug-in parses to configure VPN vendor specific settings.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

Remarks

Note

Any call to this API outside of a connected VPN plug-in will fail, as activity and interactions between the VPN plug-in and the system are controlled by the VPN profile. There can only be one VPN profile per process because the VPN plug-in only has one VPN profile mapped to it, and if a caller were to create more than one profile object, they would all refer to the same settings.

ServerHostNameList ServerHostNameList ServerHostNameList ServerHostNameList

Gets the server hostname of the VPN server to which the VPN plug-in should connect.

public : IVectorView<HostName> ServerHostNameList { get; }public IReadOnlyList<HostName> ServerHostNameList { get; }Public ReadOnly Property ServerHostNameList As IReadOnlyList<HostName>// This API is not available in Javascript.
Value
IVectorView<HostName> IReadOnlyList<HostName> IReadOnlyList<HostName> IReadOnlyList<HostName>

The server hostname of the VPN server to which the VPN plug-in should connect.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

Remarks

Note

Any call to this API outside of a connected VPN plug-in will fail, as activity and interactions between the VPN plug-in and the system are controlled by the VPN profile. There can only be one VPN profile per process because the VPN plug-in only has one VPN profile mapped to it, and if a caller were to create more than one profile object, they would all refer to the same settings.

ServerServiceName ServerServiceName ServerServiceName ServerServiceName

Gets the service name of the VPN server listening for remote access connections.

public : PlatForm::String ServerServiceName { get; }public string ServerServiceName { get; }Public ReadOnly Property ServerServiceName As string// This API is not available in Javascript.
Value
PlatForm::String string string string

The service name of the VPN server listening for remote access connections. Also known as the VPN server port.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

Remarks

Note

Any call to this API outside of a connected VPN plug-in will fail, as activity and interactions between the VPN plug-in and the system are controlled by the VPN profile. There can only be one VPN profile per process because the VPN plug-in only has one VPN profile mapped to it, and if a caller were to create more than one profile object, they would all refer to the same settings.

ServerUris ServerUris ServerUris ServerUris

Gets the list of URIs that describe the VPN servers to connect to and the URI to use when connecting to them. This is analogous to the ServerHostNames, but are in URI format which allows for more information to be carried per server.

public : IVectorView<Uri> ServerUris { get; }public IReadOnlyList<Uri> ServerUris { get; }Public ReadOnly Property ServerUris As IReadOnlyList<Uri>// This API is not available in Javascript.
Value
IVectorView<Uri> IReadOnlyList<Uri> IReadOnlyList<Uri> IReadOnlyList<Uri>

The list of URIs that describe the VPN servers to connect to and the URI to use when connecting to them.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider