Export (0) Print
Expand All

RolePrincipal.ToEncryptedTicket Method

Returns the role information cached with the RolePrincipal object encrypted based on the CookieProtectionValue.

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

[SecurityPermissionAttribute(SecurityAction.Assert, Flags = SecurityPermissionFlag.SerializationFormatter)]
public string ToEncryptedTicket()

Return Value

Type: System.String
The role information cached with the RolePrincipal object encrypted based on the CookieProtectionValue.

The value returned by the ToEncryptedTicket method is stored in the roles cookie when CacheRolesInCookie is true.

The following code example writes the results of the ToEncryptedTicket method to the roles cookie.

try
{
  RolePrincipal r = (RolePrincipal)User;
  string eTicket = r.ToEncryptedTicket();
  HttpCookie cookie = new HttpCookie(Roles.CookieName, eTicket);
  cookie.Path = Roles.CookiePath;
  cookie.Expires = r.ExpireDate;
  Response.Cookies.Add(cookie);
}
catch (InvalidCastException)
{
  Response.Write("User is not of type RolePrincipal. Are roles enabled?");
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft