Roles.CookieTimeout Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the number of minutes before the roles cookie expires.

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

Public Shared ReadOnly Property CookieTimeout As Integer

Property Value

Type: System.Int32

An integer specifying the number of minutes before the roles cookie expires. The default is 30 minutes.

The CookieTimeout property is used when the CookieSlidingExpiration property is true and specifies the time-to-live in minutes for the roles cookie. To set the CookieTimeout value, add the cookieTimeout attribute to the element in the Web.config file for the ASP.NET application and specify an integer value.

If CookieSlidingExpiration is false, this property is ignored.

The following example shows the element in the system.web section of the Web.config file for an ASP.NET application. It specifies that the application uses a SqlRoleProvider instance and sets the CookieTimeout property to 30 minutes.

<roleManager defaultProvider="SqlProvider" 
  enabled="true"
  cacheRolesInCookie="true"
  cookieName=".ASPROLES"
  cookieTimeout="30"
  cookiePath="/MyApplication"
  cookieRequireSSL="true"
  cookieSlidingExpiration="true"
  cookieProtection="Encrypted" >
  <providers>
  <add
    name="SqlProvider"
    type="System.Web.Security.SqlRoleProvider"
    connectionStringName="SqlServices"
    applicationName="MyApplication" />
  </providers>
</roleManager>

.NET Framework
Available since 2.0
Return to top
Show: