VpnChannel.RequestCredentialsAsync Method

Definition

Namespace:

Windows.Networking.Vpn

Overloads

RequestCredentialsAsync(VpnCredentialType)	Requests the VPN platform to collect credentials of a given credential type from the user.
RequestCredentialsAsync(VpnCredentialType, UInt32)	Requests the VPN platform to collect credentials from the user. The plug-in can specify the type and form of credentials to collect. The result is an object containing the main credentials depending on the type, and the secondary credentials for change and expiration cases.
RequestCredentialsAsync(VpnCredentialType, UInt32, Certificate)	VPN platform to collect credentials from the user. If user interaction is required to obtain a credential or consent, the platform provides the necessary user interaction. A VPN plug-in must request credentials before using any type of credential, even if the intent is not to invoke user interaction for it.

RequestCredentialsAsync(VpnCredentialType)

Requests the VPN platform to collect credentials of a given credential type from the user.

public:
 virtual IAsyncOperation<VpnCredential ^> ^ RequestCredentialsAsync(VpnCredentialType credType) = RequestCredentialsAsync;

/// [Windows.Foundation.Metadata.Overload("RequestCredentialsSimpleAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<VpnCredential> RequestCredentialsAsync(VpnCredentialType const& credType);

[Windows.Foundation.Metadata.Overload("RequestCredentialsSimpleAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<VpnCredential> RequestCredentialsAsync(VpnCredentialType credType);

function requestCredentialsAsync(credType)

Public Function RequestCredentialsAsync (credType As VpnCredentialType) As IAsyncOperation(Of VpnCredential)

Parameters

credType

VpnCredentialType

An enum value indicating the type of credential to collect.

Returns

IAsyncOperation<VpnCredential>

An asynchronous retrieval operation on a VpnCredential object containing the main credentials of the requested type, and secondary credentials for change and expiration cases.

Attributes

OverloadAttribute RemoteAsyncAttribute

Windows requirements

App capabilities

networkingVpnProvider

See also

• RequestCredentialsAsync(VpnCredentialType, UInt32, Certificate)
• RequestCredentialsAsync(VpnCredentialType, UInt32)

RequestCredentialsAsync(VpnCredentialType, UInt32)

Requests the VPN platform to collect credentials from the user. The plug-in can specify the type and form of credentials to collect. The result is an object containing the main credentials depending on the type, and the secondary credentials for change and expiration cases.

public:
 virtual IAsyncOperation<VpnCredential ^> ^ RequestCredentialsAsync(VpnCredentialType credType, unsigned int credOptions) = RequestCredentialsAsync;

/// [Windows.Foundation.Metadata.Overload("RequestCredentialsWithOptionsAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<VpnCredential> RequestCredentialsAsync(VpnCredentialType const& credType, uint32_t const& credOptions);

[Windows.Foundation.Metadata.Overload("RequestCredentialsWithOptionsAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<VpnCredential> RequestCredentialsAsync(VpnCredentialType credType, uint credOptions);

function requestCredentialsAsync(credType, credOptions)

Public Function RequestCredentialsAsync (credType As VpnCredentialType, credOptions As UInteger) As IAsyncOperation(Of VpnCredential)

Parameters

credType

VpnCredentialType

An enum value indicating the type of credential to collect.

credOptions

UInt32

unsigned int

uint32_t

Specifies the values defining whether a requested credential is a retry case, or should be used for single sign on.

See VpnChannelRequestCredentialsOptions for possible values.

Returns

IAsyncOperation<VpnCredential>

An asynchronous retrieval operation on a VpnCredential object containing the main credentials of the requested type, and secondary credentials for change and expiration cases.

Attributes

OverloadAttribute RemoteAsyncAttribute

Windows requirements

App capabilities

networkingVpnProvider

See also

• RequestCredentialsAsync(VpnCredentialType, UInt32, Certificate)
• RequestCredentialsAsync(VpnCredentialType)

RequestCredentialsAsync(VpnCredentialType, UInt32, Certificate)

VPN platform to collect credentials from the user. If user interaction is required to obtain a credential or consent, the platform provides the necessary user interaction. A VPN plug-in must request credentials before using any type of credential, even if the intent is not to invoke user interaction for it.

public:
 virtual IAsyncOperation<VpnCredential ^> ^ RequestCredentialsAsync(VpnCredentialType credType, unsigned int credOptions, Certificate ^ certificate) = RequestCredentialsAsync;

/// [Windows.Foundation.Metadata.Overload("RequestCredentialsWithCertificateAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<VpnCredential> RequestCredentialsAsync(VpnCredentialType const& credType, uint32_t const& credOptions, Certificate const& certificate);

[Windows.Foundation.Metadata.Overload("RequestCredentialsWithCertificateAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<VpnCredential> RequestCredentialsAsync(VpnCredentialType credType, uint credOptions, Certificate certificate);

function requestCredentialsAsync(credType, credOptions, certificate)

Public Function RequestCredentialsAsync (credType As VpnCredentialType, credOptions As UInteger, certificate As Certificate) As IAsyncOperation(Of VpnCredential)

Parameters

credType

VpnCredentialType

An enum value indicating the type of credential to collect.

credOptions

UInt32

unsigned int

uint32_t

Specifies the values defining whether a requested credential is a retry case, or should be used for single sign on.

See VpnChannelRequestCredentialsOptions for possible values.

certificate

Certificate

A certificate to be used in validating the credential.

Returns

IAsyncOperation<VpnCredential>

An asynchronous retrieval operation on a VpnCredential object containing the main credentials of the requested type, and secondary credentials for change and expiration cases.

Attributes

OverloadAttribute RemoteAsyncAttribute

Windows requirements

App capabilities

networkingVpnProvider

See also

• RequestCredentialsAsync(VpnCredentialType, UInt32)
• RequestCredentialsAsync(VpnCredentialType)