FormsAuthenticationEventHandler デリゲート

.NET Framework クラス ライブラリ リファレンス

FormsAuthenticationEventHandler デリゲート

FormsAuthenticationModule の FormsAuthentication_OnAuthenticate イベントを処理するメソッドを表します。

名前空間: System.Web.Security
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Delegate Sub FormsAuthenticationEventHandler
 ( _
    sender As Object, _
    e As FormsAuthenticationEventArgs _
)

Visual Basic (使用法)

Dim instance As New FormsAuthenticationEventHandler(AddressOf
 HandlerMethod)

C#

public delegate void FormsAuthenticationEventHandler
 (
    Object sender,
    FormsAuthenticationEventArgs e
)

C++

public delegate void FormsAuthenticationEventHandler
 (
    Object^ sender, 
    FormsAuthenticationEventArgs^ e
)

J#

/** @delegate */
public delegate void FormsAuthenticationEventHandler
 (
    Object sender, 
    FormsAuthenticationEventArgs e
)

JScript

JScript では、デリゲートは使用できますが、新規に宣言することはできません。

パラメータ

sender

イベントのソース。

e

イベント データを格納している FormsAuthenticationEventArgs。

解説

FormsAuthenticationEventHandler デリゲートは、FormsAuthenticationModule クラスの Authenticate イベントに対して定義されています。FormsAuthenticationModule クラスの Authenticate イベントには、ASP.NET アプリケーションの Global.asax ファイルに、FormsAuthentication_OnAuthenticate というサブルーチンを指定することによってアクセスできます。Authenticate イベントは、AuthenticateRequest イベント時に生成されます。

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

FormsAuthentication_OnAuthenticate イベントに渡した FormsAuthenticationEventArgs オブジェクトの User プロパティを使用して、現在の HttpContext の User プロパティを、カスタムの IPrincipal オブジェクトに設定できます。FormsAuthentication_OnAuthenticate イベント中に User プロパティ値を指定しない場合、Cookie または URL 内のフォーム認証チケットによって提供される ID が使用されます。

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

使用例

FormsAuthentication_OnAuthenticate イベントを使用して、現在の HttpContext の User プロパティにカスタム Identity を持つ GenericPrincipal オブジェクトを設定するコード例を次に示します。

Visual Basic

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

C#

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.");
  }
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
System.Web.Security 名前空間
その他の技術情報
フォーム認証プロバイダ