This documentation is archived and is not being maintained.

Roles.CookieName Property

Gets the name of the cookie where role names are cached.

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

Public Shared ReadOnly Property CookieName As String
Dim value As String

value = Roles.CookieName

/** @property */
public static String get_CookieName ()

public static function get CookieName () : String

Not applicable.

Property Value

The name of the cookie where role names are cached. The default is .ASPXROLES.

You can specify the name of the cookie where roles are cached for your application by setting the cookieName attribute in the Web.config file for your ASP.NET application. This is useful when you want to uniquely identify a cookie for your application or when a cookie is shared across multiple applications, such as a domain cookie.

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 cookieName attribute to .ASPROLES.

<roleManager defaultProvider="SqlProvider" 
  cookieProtection="All" >
      applicationName="MyApplication" />

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0