FormsAuthenticationConfiguration.Timeout Property (System.Web.Configuration)

Microsoft Developer Network

Timeout Property

.NET Framework Class Library

FormsAuthenticationConfiguration..::.Timeout Property

Gets or sets the authentication time-out.

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

Syntax

Visual Basic (Declaration)

<TypeConverterAttribute(GetType(TimeSpanMinutesConverter))> _
<ConfigurationPropertyAttribute("timeout", DefaultValue := "00:30:00")> _
<TimeSpanValidatorAttribute(MinValueString := "00:00:00", MaxValueString := "10675199.02:48:05.4775807")> _
Public Property Timeout As TimeSpan

Visual Basic (Usage)

Dim instance As FormsAuthenticationConfiguration
Dim value As TimeSpan

value = instance.Timeout

instance.Timeout = value

[TypeConverterAttribute(typeof(TimeSpanMinutesConverter))]
[ConfigurationPropertyAttribute("timeout", DefaultValue = "00:30:00")]
[TimeSpanValidatorAttribute(MinValueString = "00:00:00", MaxValueString = "10675199.02:48:05.4775807")]
public TimeSpan Timeout { get; set; }

Visual C++

[TypeConverterAttribute(typeof(TimeSpanMinutesConverter))]
[ConfigurationPropertyAttribute(L"timeout", DefaultValue = L"00:30:00")]
[TimeSpanValidatorAttribute(MinValueString = L"00:00:00", MaxValueString = L"10675199.02:48:05.4775807")]
public:
property TimeSpan Timeout {
    TimeSpan get ();
    void set (TimeSpan value);
}

JScript

public function get Timeout () : TimeSpan
public function set Timeout (value : TimeSpan)

Property Value

Type: System..::.TimeSpan
The amount of time in minutes after which the authentication expires. The default value is 30 minutes.

Examples

The following code example shows how to access the Timeout property. Refer to the code example in the FormsAuthenticationConfiguration class topic to learn how to get the section.

Visual Basic

' Get the current Timeout.
  Dim currentTimeout As System.TimeSpan = _
  formsAuthentication.Timeout

' Set the Timeout.
  formsAuthentication.Timeout = _
  System.TimeSpan.FromMinutes(10)

// Get the current Timeout.
System.TimeSpan currentTimeout = 
    formsAuthentication.Timeout;

// Set the Timeout.
formsAuthentication.Timeout = 
    System.TimeSpan.FromMinutes(10);

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

FormsAuthenticationConfiguration Class

FormsAuthenticationConfiguration Members

System.Web.Configuration Namespace

SlidingExpiration

Other Resources

forms Element for authentication (ASP.NET Settings Schema)