Click or drag to resize

VGHttpModuleAuthenticate Method

Authenticates a user for the specified HttpContext.

Namespace:  Novalys.VisualGuard.Security.WebForm
Assembly:  Novalys.VisualGuard.Security.WebForm (in Novalys.VisualGuard.Security.WebForm.dll) Version: 2018.1.720.18 (2018.1.0720.18)
Syntax
Copy
public VGAuthenticationState Authenticate(
	HttpContext context,
	string name,
	string password,
	VGAuthenticationMode mode
)

Parameters

context
Type: System.WebHttpContext
A valid HttpContext representing the context for which the security is loaded.
name
Type: SystemString
the name of the user.
password
Type: SystemString
the password of the given user.
mode
Type: Novalys.VisualGuard.SecurityVGAuthenticationMode
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.
Exceptions
ExceptionCondition
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.
ArgumentNullException The name or the password or context is null (Nothing in VB) and the mode is not Windows.
NotSupportedException

the repository does not support the specified authentication mode.

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.
Remarks
This method will replace the User property. When the authentication fails, the User property is set to null. For more information about this method, you can see Authenticate(String, String, VGAuthenticationMode).
See Also