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
Public Function ToEncryptedTicket As String
'Usage
Dim instance As RolePrincipal
Dim returnValue As String

returnValue = instance.ToEncryptedTicket
public String ToEncryptedTicket ()
public function ToEncryptedTicket () : String
Not applicable.

Return Value

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 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

Community Additions

ADD
Show: