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
Available since 2.0
Return to top
Show: