Authenticate

Security Manager Module

Description Authenticates the UserName, Password and Namespace of a user.
Returns Boolean
Usage Script Only.
Function Groups: Security
Related to: AlternateLogoff | AlternateLogon | LogOff | QuietLogon | UserCredChange | UserLogonDialog
Format \SecurityManager.Authenticate(UserName, Password [,Namespace, Privilege, Device, DontLog]);
Parameters  
UserName
The username with which to authenticate.
Password
The password to validate against the given UserName.
Namespace
Optional. The namespace of the user. Defaults to none.
Privilege
Optional. A privilege that the account must pass a SecurityCheck with. Defaults to none.
Device
Optional. Name of the device that is making the request. Defaults to none. Only used for security log messages.
DontLog
Optional. A Boolean. If TRUE, the result of the Authenticate request will not be logged in the security event log. Defaults to FALSE.
PtrAccountID
Optional. A pointer to a variable that the AccountID of the user will be stored in.
Comments

If the authentication fails, a failure event is recorded in the security event log and FALSE is returned.

If the authentication succeeds, TRUE is returned and the AccountID of the user is written into the variable addressed by the PtrAccountID parameter.

If Privilege is valid, the Privilege is used in a SecurityCheck and the result of the SecurityCheck is returned.