AuthenticateEventArgs Class
Provides data for the Authenticate event.
Assembly: System.Web (in System.Web.dll)
| Name | Description | |
|---|---|---|
![]() | AuthenticateEventArgs() | Initializes a new instance of the AuthenticateEventArgs class with the Authenticated property set to false. |
![]() | AuthenticateEventArgs(Boolean) | Initializes a new instance of the AuthenticateEventArgs class. |
| Name | Description | |
|---|---|---|
![]() | Authenticated | Gets or sets a value indicating whether a user's authentication attempt succeeded. |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | Determines whether the specified object is equal to the current object.(Inherited from Object.) |
![]() | Finalize() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.) |
![]() | GetHashCode() | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType() | |
![]() | MemberwiseClone() | |
![]() | ToString() | Returns a string that represents the current object.(Inherited from Object.) |
The AuthenticateEventArgs class provides the data needed for the Authenticate event. Custom authentication schemes for a Web site use the Authenticated property to indicate whether a user's login attempt succeeded.
The following code example uses the AuthenticateEventArgs class to pass data to a custom authentication method.
<%@ Page Language="VB" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> Function SiteSpecificAuthenticationMethod(ByVal UserName As String, ByVal Password As String) As Boolean ' Insert code that implements a site-specific custom ' authentication method here. ' ' This example implementation always returns false. Return False End Function Sub OnAuthenticate(ByVal sender As Object, ByVal e As AuthenticateEventArgs) Dim Authenticated As Boolean Authenticated = SiteSpecificAuthenticationMethod(Login1.UserName, Login1.Password) e.Authenticated = Authenticated End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>ASP.NET Example</title> </head> <body> <form id="form1" runat="server"> <asp:Login id="Login1" runat="server" OnAuthenticate="OnAuthenticate"> </asp:Login> </form> </body> </html>
Available since 2.0
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
.jpeg?cs-save-lang=1&cs-lang=vb)
.jpeg?cs-save-lang=1&cs-lang=vb)
.jpeg?cs-save-lang=1&cs-lang=vb)