Encrypt Method

FormsAuthentication.Encrypt Method

Creates a string containing an encrypted forms-authentication ticket suitable for use in an HTTP cookie.

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

public static function Encrypt(
	ticket : FormsAuthenticationTicket
) : String

Parameters

ticket
Type: System.Web.Security.FormsAuthenticationTicket

The FormsAuthenticationTicket object with which to create the encrypted forms-authentication ticket.

Return Value

Type: System.String
A string containing an encrypted forms-authentication ticket.

ExceptionCondition
ArgumentNullException

ticket is a null reference (Nothing in Visual Basic).

The following code example stores the result of the Encrypt method in a cookie by using the FormsCookieName property and redirects the user to the URL returned from the GetRedirectUrl method.

Security noteSecurity Note:

This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

No code example is currently available or this language may not be supported.

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, 1.1, 1.0

Community Additions

ADD
Show:
© 2016 Microsoft