Freigeben über

FormsAuthenticationEventArgs Klasse

Definition

Namespace:
System.Web.Security
Assembly:
System.Web.dll

Stellt Daten für das FormsAuthentication_OnAuthenticate-Ereignis bereit . Diese Klasse kann nicht vererbt werden.

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

Beispiele

Im folgenden Codebeispiel wird das FormsAuthentication_OnAuthenticate-Ereignis verwendet, um die User Eigenschaft des aktuellen HttpContext Objekts auf ein GenericPrincipal Objekt mit einer benutzerdefinierten IdentityEigenschaft festzulegen.

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 Ereigniswerte für das FormsAuthentication_OnAuthenticate-Ereignis bereitzustellen und Ihnen die Angabe einer benutzerdefinierten Identität für die aktuelle Anforderung zu ermöglichen.

Das FormsAuthenticationModule Objekt wird FormsAuthenticationEventArgs mithilfe des aktuellen HttpContext Objekts erstellt und an das FormsAuthentication_OnAuthenticate-Ereignis übergeben.

Mit der User Eigenschaft können Sie die User Eigenschaft des aktuellen HttpContext Objekts auf ein benutzerdefiniertes IPrincipal Objekt festlegen.

Wenn Sie während des FormsAuthentication_OnAuthenticate-Ereignisses keinen Wert für die User Eigenschaft angeben, wird die vom Formularauthentifizierungsticket im Cookie oder der URL angegebene Identität verwendet.

Das FormsAuthentication_OnAuthenticate-Ereignis wird nur ausgelöst, wenn die Authentifizierung Mode auf ein FormsAuthenticationModule aktives HTTP-Modul für die Anwendung festgelegt Forms ist.

Konstruktoren

Name Beschreibung
FormsAuthenticationEventArgs(HttpContext)

Initialisiert eine neue Instanz der FormsAuthenticationEventArgs-Klasse.

Eigenschaften

Name Beschreibung
Context

Ruft das HttpContext Objekt für die aktuelle HTTP-Anforderung ab.
User

Dient zum Abrufen oder Festlegen des IPrincipal Objekts, das der aktuellen Anforderung zugeordnet werden soll.

Methoden

Name Beschreibung
Equals(Object)

Bestimmt, ob das angegebene Objekt dem aktuellen Objekt entspricht.

(Geerbt von Object)
GetHashCode()

Dient als Standardhashfunktion.

(Geerbt von Object)
GetType()

Ruft die Type der aktuellen Instanz ab.

(Geerbt von Object)
MemberwiseClone()

Erstellt eine flache Kopie der aktuellen Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.

(Geerbt von Object)

Gilt für:

Weitere Informationen