VGSecurityRuntimeAuthenticate Method (String, String, VGAuthenticationMode) |
Authenticates a user by using the specified authentication mode.
Namespace: Novalys.VisualGuard.Security
Assembly: Novalys.VisualGuard.Security (in Novalys.VisualGuard.Security.dll) Version: 2019.1.831.19 (2019.1.0831.19)
Syntaxpublic VGAuthenticationState Authenticate( string name, string password, VGAuthenticationMode mode )
Parameters
- 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: VGAuthenticationStateA VGAuthenticationState indicating if the authentication succeeds or not.
Exceptions| Exception | Condition |
|---|---|
| ArgumentException | The 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 is null (Nothing in VB) and the mode is not Windows. |
| NotSupportedException | the repository does not support the specified authentication mode. |
| 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. |
Remarks
For more information about this method, you can see Authenticate(String, String, VGAuthenticationMode).
See Also