MachineKey::Encode Method

Visual Studio 2010

Other Versions

.NET Framework (current version)

Encrypts data and/or appends a hash-based message authentication code (HMAC).

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

Syntax

C++

public:
static String^ Encode(
	array<unsigned char>^ data, 
	MachineKeyProtection protectionOption
)

Parameters

data: Type: array<System::Byte>
The data to encrypt.

protectionOption: Type: System.Web.Security::MachineKeyProtection
Indicates whether the data parameter should be encrypted and/or hashed.

Return Value

Type: System::String
The encrypted value, the input value with an HMAC appended, or the result of encrypting the input value with an HMAC appended.

Remarks

For information about which encryption and hashing algorithms ASP.NET uses to decrypt and validate the data that is passed in, see machineKey Element (ASP.NET Settings Schema).

Examples

For a code example, see the MachineKey class overview.

Version Information

.NET Framework

Supported in: 4

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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