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 и для указания пользовательского удостоверения для текущего запроса.

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

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

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

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

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

FormsAuthenticationEventArgs(HttpContext)

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

Свойства

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

Методы

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

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

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