Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

WindowsAuthenticationEventHandler Delegate

Represents the method that handles the WindowsAuthentication_OnAuthenticate event of a WindowsAuthenticationModule.

Namespace: System.Web.Security
Assembly: System.Web (in system.web.dll)
public delegate void WindowsAuthenticationEventHandler (
	Object sender,
	WindowsAuthenticationEventArgs e
)
/** @delegate */
public delegate void WindowsAuthenticationEventHandler (
	Object sender, 
	WindowsAuthenticationEventArgs e
)
Not applicable.

Parameters

sender

The source of the event.

e

A WindowsAuthenticationEventArgs that contains the event data.

The WindowsAuthenticationEventHandler delegate is defined for the Authenticate event of the WindowsAuthenticationModule class. You can access the Authenticate event of the WindowsAuthenticationModule class by specifying a subroutine named WindowsAuthentication_OnAuthenticate in the Global.asax file for your ASP.NET application. The Authenticate event is raised during the AuthenticateRequest event.

The WindowsAuthenticationModule constructs a WindowsAuthenticationEventArgs object using the Windows identity supplied by IIS and the current HttpContext and passes it to the WindowsAuthentication_OnAuthenticate event.

You can use the User property of the WindowsAuthenticationEventArgs object supplied to the WindowsAuthentication_OnAuthenticate event to set the User property of the current HttpContext to a custom IPrincipal object. If you do not specify a value for the User property during the WindowsAuthentication_OnAuthenticate event, the Windows identity supplied by IIS is used as the identity for the current request. If IIS uses anonymous authentication, then the Identity property of the WindowsAuthenticationEventArgs object is set to the identity returned by the GetAnonymous method.

The WindowsAuthentication_OnAuthenticate event is only raised when the authentication Mode is set to Windows and the WindowsAuthenticationModule is an active HTTP module for the application.

The following code example uses the WindowsAuthentication_OnAuthenticate event to set the User property of the current HttpContext to a custom IPrincipal object.

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

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.