FormsAuthenticationEventArgs Klasse

Definition

Stellt Daten für das Ereignis FormsAuthentication_OnAuthenticate bereits.Provides data for the FormsAuthentication_OnAuthenticate event. Diese Klasse kann nicht vererbt werden.This class cannot be inherited.

public ref class FormsAuthenticationEventArgs sealed : EventArgs
public sealed class FormsAuthenticationEventArgs : EventArgs
type FormsAuthenticationEventArgs = class
    inherit EventArgs
Public NotInheritable Class FormsAuthenticationEventArgs
Inherits EventArgs
Vererbung
FormsAuthenticationEventArgs

Beispiele

Im folgenden Codebeispiel wird das FormsAuthentication_OnAuthenticate -Ereignis verwendet, um die User-Eigenschaft des aktuellen HttpContext auf ein GenericPrincipal Objekt mit einem benutzerdefinierten Identityfestzulegen.The following code example uses the FormsAuthentication_OnAuthenticate event to set the User property of the current HttpContext to a GenericPrincipal object with a custom Identity.

public void FormsAuthentication_OnAuthenticate(object sender, FormsAuthenticationEventArgs args)
{
  if (FormsAuthentication.CookiesSupported)
  {
    if (Request.Cookies[FormsAuthentication.FormsCookieName] != null)
    {
      try
      {
        FormsAuthenticationTicket ticket = FormsAuthentication.Decrypt(
          Request.Cookies[FormsAuthentication.FormsCookieName].Value);
        
        args.User = new System.Security.Principal.GenericPrincipal(
          new Samples.AspNet.Security.MyFormsIdentity(ticket),
          new string[0]);
      }
      catch (Exception e)
      {
        // Decrypt method failed.
      }
    }
  }
  else
  {
    throw new HttpException("Cookieless Forms Authentication is not " +
                            "supported for this application.");
  }
}
Public Sub FormsAuthentication_OnAuthenticate(sender As Object, _
                                              args As FormsAuthenticationEventArgs)
  If FormsAuthentication.CookiesSupported Then
    If Not Request.Cookies(FormsAuthentication.FormsCookieName) Is Nothing Then
      Try
        Dim ticket As FormsAuthenticationTicket = FormsAuthentication.Decrypt( _
          Request.Cookies(FormsAuthentication.FormsCookieName).Value)
        
        args.User = New System.Security.Principal.GenericPrincipal( _
          New Samples.AspNet.Security.MyFormsIdentity(ticket), _
          New String(0) {})
      Catch e As HttpException
        ' Decrypt method failed.
      End Try
    End If
  Else
      Throw New Exception("Cookieless Forms Authentication is not " & _
                            "supported for this application.")
  End If
End Sub

Hinweise

Die FormsAuthenticationEventArgs-Klasse wird verwendet, um Ereignis Werte für das FormsAuthentication_OnAuthenticate Ereignis bereitzustellen und um Ihnen die Angabe einer benutzerdefinierten Identität für die aktuelle Anforderung zu ermöglichen.The FormsAuthenticationEventArgs class is used to supply event values to the FormsAuthentication_OnAuthenticate event and to enable you to specify a custom identity for the current request.

Der FormsAuthenticationModule erstellt ein FormsAuthenticationEventArgs-Objekt mit dem aktuellen HttpContext und übergibt es an das FormsAuthentication_OnAuthenticate Ereignis.The FormsAuthenticationModule constructs a FormsAuthenticationEventArgs object using the current HttpContext and passes it to the FormsAuthentication_OnAuthenticate event.

Sie können die User-Eigenschaft verwenden, um die User-Eigenschaft des aktuellen HttpContext auf ein benutzerdefiniertes IPrincipal Objekt festzulegen.You can use the User property to set the User property of the current HttpContext to a custom IPrincipal object.

Wenn Sie während des FormsAuthentication_OnAuthenticate Ereignisses keinen Wert für die User-Eigenschaft angeben, wird die Identität verwendet, die vom Formular Authentifizierungs Ticket im Cookie oder in der URL bereitgestellt wird.If you do not specify a value for the User property during the FormsAuthentication_OnAuthenticate event, the identity supplied by the forms authentication ticket in the cookie or URL is used.

Das FormsAuthentication_OnAuthenticate -Ereignis wird nur ausgelöst, wenn die Authentifizierungs Mode auf Forms festgelegt ist und der FormsAuthenticationModule ein aktives HTTP-Modul für die Anwendung ist.The FormsAuthentication_OnAuthenticate event is only raised when the authentication Mode is set to Forms and the FormsAuthenticationModule is an active HTTP module for the application.

Konstruktoren

FormsAuthenticationEventArgs(HttpContext)

Initialisiert eine neue Instanz der FormsAuthenticationEventArgs-Klasse.Initializes a new instance of the FormsAuthenticationEventArgs class.

Eigenschaften

Context

Ruft das HttpContext-Objekt für die aktuelle HTTP-Anforderung ab.Gets the HttpContext object for the current HTTP request.

User

Ruft das IPrincipal-Objekt ab, das der aktuellen Anforderung zugeordnet werden soll, oder legt dieses fest.Gets or sets the IPrincipal object to be associated with the current request.

Methoden

Equals(Object)

Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist.Determines whether the specified object is equal to the current object.

(Geerbt von Object)
GetHashCode()

Dient als die Standard-HashfunktionServes as the default hash function.

(Geerbt von Object)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Gilt für:

Siehe auch