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 イベントを使用して、現在HttpContextの の プロパティをカスタム Identityの オブジェクトにGenericPrincipal設定Userします。

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 イベントにイベント値を指定し、現在の要求のカスタム ID を指定するために使用されます。

はFormsAuthenticationModule、現在HttpContextの をFormsAuthenticationEventArgs使用して オブジェクトを構築し、それを FormsAuthentication_OnAuthenticate イベントに渡します。

プロパティをUser使用して、現在HttpContextの の プロパティをUserカスタム IPrincipal オブジェクトに設定できます。

FormsAuthentication_OnAuthenticate イベント中に プロパティのUser値を指定しない場合は、フォーム認証チケットによって Cookie または URL で指定された ID が使用されます。

FormsAuthentication_OnAuthenticate イベントは、認証Modeが にForms設定されていてFormsAuthenticationModule、 がアプリケーションのアクティブな HTTP モジュールである場合にのみ発生します。

コンストラクター

FormsAuthenticationEventArgs(HttpContext)

FormsAuthenticationEventArgs クラスの新しいインスタンスを初期化します。

プロパティ

Context

現在の HTTP 要求に対する HttpContext オブジェクトを取得します。
User

現在の要求に関連付ける IPrincipal オブジェクトを取得または設定します。

メソッド

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。

(継承元 Object)
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)

適用対象

こちらもご覧ください