Checks if credentials are valid but does not load security permissions or change current principal.

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

Syntax

C#
public VGAuthenticationState CheckCredential(
	string name,
	string password,
	VGAuthenticationMode mode
)
Visual Basic (Declaration)
Public Function CheckCredential ( _
	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 user
mode
Type: Novalys.VisualGuard.Security..::.VGAuthenticationMode
A VGAuthenticationMode value indicating the authentication mode used to validate the user.

Return Value

true if the credentials are valid, false otherwise.

Remarks

this method does not update credential statistic

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 contains invalid chars ('\', '/', '?', '*', '%', ';', ''', '"', ':', '|', '[', ']', '+', '=', ',').

- 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 Visual Guard authentication mode.

The name is empty.

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