Authenticates a user by using the specified authentication mode.

Namespace: Novalys.VisualGuard.Security
Assembly: Novalys.VisualGuard.Security (in Novalys.VisualGuard.Security.dll) Version: 2016.0.105.16 (2016.0.105.16)

Syntax

C#
public VGAuthenticationState Authenticate(
	string name,
	string password,
	VGAuthenticationMode mode
)
Visual Basic
Public Function Authenticate ( 
	name As String,
	password As String,
	mode As VGAuthenticationMode
) As VGAuthenticationState

Parameters

name
Type: System..::..String
the name of the user.
password
Type: System..::..String
the password of the given user.
mode
Type: Novalys.VisualGuard.Security..::..VGAuthenticationMode
A VGAuthenticationMode indicating the mode of authentication used to authenticate the user

Return Value

Type: VGAuthenticationState
A VGAuthenticationState indicating if the authentication succeeds or not.

Remarks

For more information about this method, you can see Authenticate(String, String, VGAuthenticationMode).

Exceptions

ExceptionCondition
System..::..ArgumentExceptionThe value of mode is equal to None or is a combination of several modes.

- or-

the name is an empty string or is longer than 64 characters.

- or-

the password is longer than 64 characters.
System..::..ArgumentNullException The name or the password is null (Nothing in VB) and the mode is not Windows.
System..::..NotSupportedException

the repository does not support the specified authentication mode.

Novalys.VisualGuard.Security..::..VGConfigurationExceptionThe configuration file is not valid

or

A problem occurs during the connection to the repository.

or

The version of the repository or the version of the permissions is not supported by the application.

See Also