WindowsAuthenticationEventHandler デリゲート

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

WindowsAuthenticationEventHandler デリゲート

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

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

Visual Basic (宣言)

Public Delegate Sub WindowsAuthenticationEventHandler
 ( _
    sender As Object, _
    e As WindowsAuthenticationEventArgs _
)

Visual Basic (使用法)

Dim instance As New WindowsAuthenticationEventHandler(AddressOf
 HandlerMethod)

C#

public delegate void WindowsAuthenticationEventHandler
 (
    Object sender,
    WindowsAuthenticationEventArgs e
)

C++

public delegate void WindowsAuthenticationEventHandler
 (
    Object^ sender, 
    WindowsAuthenticationEventArgs^ e
)

J#

/** @delegate */
public delegate void WindowsAuthenticationEventHandler
 (
    Object sender, 
    WindowsAuthenticationEventArgs e
)

JScript

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

パラメータ

sender

イベントのソース。

e

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

解説

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

WindowsAuthenticationModule は、IIS によって提供された Windows ID と現在の HttpContext を使用して WindowsAuthenticationEventArgs オブジェクトを生成し、それを WindowsAuthentication_OnAuthenticate イベントに渡します。

WindowsAuthentication_OnAuthenticate イベントに渡した WindowsAuthenticationEventArgs オブジェクトの User プロパティを使用して、現在の HttpContext の User プロパティを、カスタムの IPrincipal オブジェクトに設定できます。WindowsAuthentication_OnAuthenticate イベント中に User プロパティ値が指定されない場合、IIS によって提供される Windows ID が現在の要求に対する ID として使用されます。IIS が匿名認証を使用する場合、WindowsAuthenticationEventArgs オブジェクトの Identity プロパティには、GetAnonymous メソッドによって返される ID が設定されます。

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

使用例

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

Visual Basic

Public Sub WindowsAuthentication_OnAuthenticate(sender
 As Object, args As WindowsAuthenticationEventArgs)
  If Not args.Identity.IsAnonymous Then
    args.User = New Samples.AspNet.Security.MyPrincipal(args.Identity)
  End If
End Sub

C#

public void WindowsAuthentication_OnAuthenticate(object
 sender, WindowsAuthenticationEventArgs args)
{
  if (!args.Identity.IsAnonymous)
  {
    args.User = new Samples.AspNet.Security.MyPrincipal(args.Identity);
  }
}

プラットフォーム

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 名前空間
その他の技術情報
Windows 認証プロバイダ