ClientFormsAuthenticationMembershipProvider.ValidateUser Method (String, String, Boolean)
Authenticates a user by using the specified user name and password, optionally storing a hash of the password in the local data cache.
Assembly: System.Web.Extensions (in System.Web.Extensions.dll)
Public Function ValidateUser ( username As String, password As String, rememberMe As Boolean ) As Boolean
Parameters
- username
-
Type:
System.String
The name of the user to authenticate.
- password
-
Type:
System.String
The password of the user to authenticate.
- rememberMe
-
Type:
System.Boolean
true to store a hash of the password in the local data cache for offline use and for automatic reauthentication when the user authentication cookie expires; false to disable offline login or to require users to reauthenticate when the cookie expires.
| Exception | Condition |
|---|---|
| WebException | The IsOffline property value is false and the membership provider is unable to access the authentication service. |
You can use client application services to validate users by using forms authentication. To validate users, you will typically call the static Membership.ValidateUser method, which internally calls the ClientFormsAuthenticationMembershipProvider.ValidateUser(String, String) method. Alternatively, you can call the ClientFormsAuthenticationMembershipProvider.ValidateUser method directly. You can call this overload to pass in a rememberMe value in addition to the username and password values.
The following example code demonstrates how to use this method to validate the user by using login controls in your application code. This example requires a TextBox control named usernameTextBox, a TextBox control named passwordTextBox, and a CheckBox control named rememberMeCheckBox.
Private Function ValidateUsingLoginControls() As Boolean Dim isAuthorized As Boolean = False Try Dim authProvider As ClientFormsAuthenticationMembershipProvider = _ CType(System.Web.Security.Membership.Provider, _ ClientFormsAuthenticationMembershipProvider) ' Call ValidateUser with credentials retrieved from login controls. isAuthorized = authProvider.ValidateUser(usernameTextBox.Text, _ passwordTextBox.Text, rememberMeCheckBox.Checked) Catch ex As System.Net.WebException MessageBox.Show("Unable to access the authentication service.", _ "Warning", MessageBoxButtons.OK, MessageBoxIcon.Warning) End Try If Not isAuthorized Then MessageBox.Show("Unable to authenticate.", "Not logged in", _ MessageBoxButtons.OK, MessageBoxIcon.Error) Application.Exit() End If Return isAuthorized End Function
Available since 3.5