Authenticates a user by using Visual Guard or Database authentication mode.
Namespace:
Novalys.VisualGuard.SecurityAssembly: Novalys.VisualGuard.Security (in Novalys.VisualGuard.Security.dll) Version: 3.2.912.1 (3.2.912.01)
Syntax
| C# |
|---|
public VGAuthenticationState Authenticate( string name, string password ) |
| Visual Basic (Declaration) |
|---|
Public Function Authenticate ( _ name As String, _ password As String _ ) As VGAuthenticationState |
Parameters
- name
- Type: System..::.String
the name of the user.
- password
- Type: System..::.String
the password of the given user.
Return Value
A VGAuthenticationState indicating if the authentication succeeds or not.
Remarks
For more information about this method, you can see Authenticate(String, String, VGAuthenticationMode).
Exceptions
| Exception | Condition |
|---|---|
| System..::.ArgumentException |
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). |
| System..::.NotSupportedException |
the repository does not support Visual Guard or Database authentication mode. The name is empty. |
| Novalys.VisualGuard.Security..::.VGConfigurationException | The 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. |