RolePrincipal.ToEncryptedTicket Method

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.

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

public:
 System::String ^ ToEncryptedTicket();

public string ToEncryptedTicket ();

member this.ToEncryptedTicket : unit -> string

Public Function ToEncryptedTicket () As String

Returns

String

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

Examples

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?");
}

Try
  Dim r As RolePrincipal = CType(User, RolePrincipal)
  Dim eTicket As String = r.ToEncryptedTicket()
  Dim cookie As HttpCookie = New HttpCookie(Roles.CookieName, eTicket)
  cookie.Path = Roles.CookiePath
  cookie.Expires = r.ExpireDate
  Response.Cookies.Add(cookie)
Catch e As InvalidCastException
  Response.Write("User is not of type RolePrincipal. Are roles enabled?")
End Try

Remarks

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

Applies to

Del via