AuthenticateEventArgs Class

.NET Framework (current version)

Other Versions

Provides data for the Authenticate event.

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)

Inheritance Hierarchy

System.Object
System.EventArgs
System.Web.UI.WebControls.AuthenticateEventArgs

Syntax

C++

type AuthenticateEventArgs = 
    class
        inherit EventArgs
    end

Constructors

	Name	Description
	AuthenticateEventArgs()	Initializes a new instance of the AuthenticateEventArgs class with the Authenticated property set to false.
	AuthenticateEventArgs(Boolean)	Initializes a new instance of the AuthenticateEventArgs class.

Properties

	Name	Description
	Authenticated	Gets or sets a value indicating whether a user's authentication attempt succeeded.

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

The AuthenticateEventArgs class provides the data needed for the Authenticate event. Custom authentication schemes for a Web site use the Authenticated property to indicate whether a user's login attempt succeeded.

Examples

The following code example uses the AuthenticateEventArgs class to pass data to a custom authentication method.

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

Version Information

.NET Framework
Available since 2.0

Thread Safety

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