FormsAuthenticationEventArgs Klasse

Definition

Namespace:

System.Web.Security

Assembly:

System.Web.dll

Stellt Daten für das Ereignis FormsAuthentication_OnAuthenticate bereits. 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 current HttpContext auf ein GenericPrincipal Objekt mit einem benutzerdefinierten Identityfestzulegen.

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 dient zum Bereitstellen von Ereigniswerten für das FormsAuthentication_OnAuthenticate-Ereignis und zum Angeben einer benutzerdefinierten Identität für die aktuelle Anforderung.

Der FormsAuthenticationModule erstellt ein FormsAuthenticationEventArgs -Objekt unter Verwendung des aktuellen HttpContext und übergibt es an das FormsAuthentication_OnAuthenticate-Ereignis .

Sie können die User -Eigenschaft verwenden, um die User Eigenschaft des aktuellen HttpContext auf ein benutzerdefiniertes IPrincipal Objekt festzulegen.

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

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

Konstruktoren

FormsAuthenticationEventArgs(HttpContext)

Initialisiert eine neue Instanz der FormsAuthenticationEventArgs-Klasse.

Eigenschaften

Context	Ruft das HttpContext-Objekt für die aktuelle HTTP-Anforderung ab.
User	Ruft das IPrincipal-Objekt ab, das der aktuellen Anforderung zugeordnet werden soll, oder legt dieses fest.

Methoden

Equals(Object)	Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object)
GetHashCode()	Fungiert als Standardhashfunktion. (Geerbt von Object)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• Formularauthentifizierungsanbieter