Roles.CookieTimeout Property

Reference

Definition

Namespace:: System.Web.Security

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the number of minutes before the roles cookie expires.

public:
 static property int CookieTimeout { int get(); };

public static int CookieTimeout { get; }

static member CookieTimeout : int

Public Shared ReadOnly Property CookieTimeout As Integer

Property Value

Int32

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

Examples

The following example shows the roleManager 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>

Remarks

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 roleManager element in the Web.config file for the ASP.NET application and specify an integer value.

If CookieSlidingExpiration is false, this property is ignored.

Applies to

Product	Versions
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Share via