LoginUser

<< Click to Display Table of Contents >>

 

LoginUser

LoginUser(Username, UserPassword, [OpStatus], [WarnDaysToExpire])

Executes a login operation for a specific user without displaying any message. The Username parameter is a user's name and the UserPassword parameter is the password for that user. The optional return parameter OpStatus is a map of bits indicating the status of that operation and the optional return parameter WarnDaysToExpire indicates the number of days until UserPassword expires. This method returns a Boolean indicating whether the operation failed or not. Please check the next tables for more information about possible values in case of failure.

 

NOTE

This method is only available if the logged-in user belongs to an Elipse Water Domain.

 

Possible return values for the OpStatus parameter

Value

Description

0x000000

No error

0x000001

Unspecified error

0x000002

Incorrect user or password

0x000004

The current password must be changed

0x000008

The current password expired

0x000010

This user's account is blocked

0x000020

This user's account is disabled

0x000040

The RPC server is not available

0x000080

Authentication mode not supported

0x001000

Password not informed

0x002000

This user has no permission to change their password

0x004000

The informed password is not alphanumerical

0x008000

The informed password does not contain upper and lower case letters

0x010000

The informed password is too short

0x020000

The informed password does not contain the minimum number of numbers

0x040000

The informed password does not contain the minimum number of letters

0x080000

The informed password does not contain the minimum number of special characters

0x100000

The informed password is equal to the user's name

0x200000

The informed password was recently used

0x400000

The current password did not reach its minimum duration

 

Possible return values for the WarnDaysToExpire parameter

Value

Description

-1 (minus one)

This password is outside the expiration interval or it never expires

0 (zero)

This password expires today

n

This password expires in n days inside the configured expiration interval

Was this page useful?