FormsAuthenticationModule Class
TOC
Collapse the table of content
Expand the table of content

FormsAuthenticationModule Class

 

Sets the identity of the user for an ASP.NET application when forms authentication is enabled. This class cannot be inherited.

Namespace:   System.Web.Security
Assembly:  System.Web (in System.Web.dll)

System.Object
  System.Web.Security.FormsAuthenticationModule

[<Sealed>]
type FormsAuthenticationModule = 
    class
        interface IHttpModule
    end

NameDescription
System_CAPS_pubmethodFormsAuthenticationModule()

Initializes a new instance of the FormsAuthenticationModule class.

NameDescription
System_CAPS_pubmethodDispose()

Releases all resources, other than memory, used by the FormsAuthenticationModule.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInit(HttpApplication)

Initializes the FormsAuthenticationModule object.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubeventAuthenticate

Occurs when the application authenticates the current request.

The FormsAuthenticationModule sets the current HttpContext.User property to an IPrincipal object that represents the user identity for the current request when the authentication Mode is set to Forms in the authentication Element (ASP.NET Settings Schema) element of the application's configuration file.

The FormsAuthenticationModule exposes an Authenticate event that enables you to provide a custom IPrincipal object for the User property of the current HttpContext. The Authenticate event is accessed by specifying a subroutine named FormsAuthentication_OnAuthenticate in the Global.asax file for your ASP.NET application.

System_CAPS_noteNote

In IIS 7.0, using the WindowsAuthenticationModule with the FormsAuthenticationModule is not supported. For more information about compatibility issues in Integrated modes, see Moving an ASP.NET Application from IIS 6.0 to IIS 7.0.

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

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft