This documentation is archived and is not being maintained.

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)

'Declaration
<SecurityPermissionAttribute(SecurityAction.Assert, Flags := SecurityPermissionFlag.SerializationFormatter)> _
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public Function ToEncryptedTicket As String
'Usage
Dim instance As RolePrincipal 
Dim returnValue As String 

returnValue = instance.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 
  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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: