AuthenticatingEventArgs.AuthenticationIsComplete AuthenticatingEventArgs.AuthenticationIsComplete AuthenticatingEventArgs.AuthenticationIsComplete AuthenticatingEventArgs.AuthenticationIsComplete Property

Definition

Gets or sets a value that indicates whether the user credentials have been authenticated.

public:
 property bool AuthenticationIsComplete { bool get(); void set(bool value); };
public bool AuthenticationIsComplete { get; set; }
member this.AuthenticationIsComplete : bool with get, set
Public Property AuthenticationIsComplete As Boolean

Property Value

true if all the steps for validating the user credentials have been performed; otherwise, false.

Examples

The following example shows an event handler that passes UserName and Password values to a custom membership provider to validate the user credentials. The event handler sets Authenticated to the return value of the ValidateUser method and sets AuthenticationIsComplete to true so that the AuthenticationService class does not validate the credentials.

void AuthenticationService_Authenticating(object sender, System.Web.ApplicationServices.AuthenticatingEventArgs e)
{
    if (e.UserName.IndexOf("@contoso.com") >= 0)
    {
        e.Authenticated = Membership.Providers["ContosoSqlProvider"].ValidateUser(e.UserName, e.Password);
    }
    else if (e.UserName.IndexOf("@fabrikam.com") >= 0)
    {
        e.Authenticated = Membership.Providers["FabrikamSqlProvider"].ValidateUser(e.UserName, e.Password);
    }
    else
    {
        e.Authenticated = Membership.Provider.ValidateUser(e.UserName, e.Password);
    }
    e.AuthenticationIsComplete = true;
}
Sub AuthenticationService_Authenticating _
   (ByVal sender As Object, _
    ByVal e As System.Web.ApplicationServices.AuthenticatingEventArgs)
    
    If (e.Username.IndexOf("@contoso.com") >= 0) Then
        e.Authenticated = Membership.Providers("ContosoSqlProvider").ValidateUser(e.Username, e.Password)
    ElseIf (e.Username.IndexOf("@fabrikam.com") >= 0) Then
        e.Authenticated = Membership.Providers("FabrikamSqlProvider").ValidateUser(e.Username, e.Password)
    Else
        e.Authenticated = Membership.Provider.ValidateUser(e.Username, e.Password)
    End If
    e.AuthenticationIsComplete = True
End Sub

Remarks

You can set the AuthenticationIsComplete property to indicate whether the AuthenticationService class must authenticate the user credentials. If AuthenticationIsComplete is true, the AuthenticationService class does not validate the user credentials through the default membership provider. Instead, it uses the value in Authenticated to determine whether to create an authentication cookie.

If AuthenticationIsComplete is false, the AuthenticationService class validates the user credentials through the default membership provider and overwrites the value in the Authenticated property.

Applies to

See also