[This is preliminary documentation and is subject to change.]

Validates a user based on a given email Address and password.

Namespace:  OfficeClip.DBLayer.Account
Assembly:  OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0

Syntax

C#
public int ValidateUserLogin(
	string emailAddress,
	string password,
	out string errMessage
)
Visual Basic (Declaration)
Public Function ValidateUserLogin ( _
	emailAddress As String, _
	password As String, _
	<OutAttribute> ByRef errMessage As String _
) As Integer
Visual C++
public:
int ValidateUserLogin(
	String^ emailAddress, 
	String^ password, 
	[OutAttribute] String^% errMessage
)

Parameters

emailAddress
Type: System..::.String
Email Address of the user.
password
Type: System..::.String
password of the user.
errMessage
Type: System..::.String%
The error message

Return Value

Integer flag indicating whether the user could be successfully authenticated. Following is the list of possible values returned and their meanings. 0 = Successful -1 = Invalid Login-password -2 = Site license expired -3 = Account license expired -4 = Database and OfficeClip Version do not match -5 = OfficeClip has undergone a major upgrade. As a result, you need to reset password using Forgot password on the website and login again. -6 = Current upgrade is incompatible with your Current OfficeClip license. -7 = User not present in the system. Ask OfficeClip Administrator to add the user

See Also