This documentation is archived and is not being maintained.

AuthenticateEventArgs.Authenticated Property

Gets or sets a value indicating whether a user's authentication attempt succeeded.

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

public bool Authenticated { get; set; }

Property Value

Type: System.Boolean
true if the authentication attempt succeeded; otherwise, false.

Use the Authenticated property in custom authentication schemes implemented in the Login.Authenticate event handler to indicate the success or failure of the user's login attempt.

Setting the Authenticated property to false indicates that the Web site user has not presented valid credentials and the Login control should raise the LoginError event in addition to displaying text that indicates the login attempt was not successful. The LoginError event enables the page developer to have additional processes or action occur when user authentication is not successful. Setting Authenticated to true indicates that the user has presented valid credentials and the Login control should raise the LoggedIn event and redirect the user back to the current page or to the page indicated by DestinationPageUrl.

The following code example uses the Authenticated property with a custom authentication scheme to indicate the success or failure of a user's login attempt.

<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
private bool SiteSpecificAuthenticationMethod(string UserName, string Password)
{
    // Insert code that implements a site-specific custom  
    // authentication method here. 
    // 
    // This example implementation always returns false. 
    return false;
}

private void OnAuthenticate(object sender, AuthenticateEventArgs e)
{
    bool Authenticated = false;
    Authenticated = SiteSpecificAuthenticationMethod(Login1.UserName, Login1.Password);

    e.Authenticated = Authenticated;
}

</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>

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: