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 Sub WindowsAuthenticationEventHandler (
	sender As Object,
	e As WindowsAuthenticationEventArgs
)

Parameters

sender
Type: System.Object

The source of the event.

e
Type: System.Web.Security.WindowsAuthenticationEventArgs

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 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

.NET Framework
Available since 1.1
Return to top
Show: