FormsAuthenticationEventArgs Класс

Определение

Пространство имен:

System.Web.Security

Сборка:

System.Web.dll

Предоставляет данные для события FormsAuthentication_OnAuthenticate . Этот класс не может быть унаследован.

public ref class FormsAuthenticationEventArgs sealed : EventArgs

public sealed class FormsAuthenticationEventArgs : EventArgs

type FormsAuthenticationEventArgs = class
    inherit EventArgs

Public NotInheritable Class FormsAuthenticationEventArgs
Inherits EventArgs

Наследование

Object

EventArgs

FormsAuthenticationEventArgs

Примеры

В следующем примере кода используется событие FormsAuthentication_OnAuthenticate для задания User свойства текущего HttpContextGenericPrincipal объекта с пользовательским.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

Комментарии

Класс FormsAuthenticationEventArgs используется для предоставления значений событий в событие FormsAuthentication_OnAuthenticate и позволяет указать пользовательское удостоверение для текущего запроса.

FormsAuthenticationEventArgs Создает FormsAuthenticationModule объект с помощью текущего HttpContext и передает его в событие FormsAuthentication_OnAuthenticate.

Свойство можно использовать User для задания User свойства текущего HttpContext пользовательского IPrincipal объекта.

Если значение свойства User не указано во время события FormsAuthentication_OnAuthenticate , используется удостоверение, предоставленное билетом проверки подлинности форм в файле cookie или URL-адресе.

Событие FormsAuthentication_OnAuthenticate возникает только при установке Forms проверки подлинности Mode и FormsAuthenticationModule является активным модулем HTTP для приложения.

Конструкторы

Имя	Описание
FormsAuthenticationEventArgs(HttpContext)	Инициализирует новый экземпляр класса FormsAuthenticationEventArgs.

Свойства

Имя	Описание
Context	HttpContext Возвращает объект для текущего HTTP-запроса.
User	Возвращает или задает объект, связанный IPrincipal с текущим запросом.

Методы

Имя	Описание
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

См. также раздел

• Поставщик проверки подлинности форм