SecurityKeyElement.DecryptKey Method

Article
10/05/2012

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Decrypts a key using the specified algorithm.

Namespace: Microsoft.IdentityModel.Tokens
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As SecurityKeyElement
Dim algorithm As String
Dim keyData As Byte()
Dim returnValue As Byte()

returnValue = instance.DecryptKey(algorithm, keyData)

Syntax

'Declaration
Public Overrides Function DecryptKey ( _
    algorithm As String, _
    keyData As Byte() _
) As Byte()

public override byte[] DecryptKey (
    string algorithm,
    byte[] keyData
)

public:
virtual array<unsigned char>^ DecryptKey (
    String^ algorithm, 
    array<unsigned char>^ keyData
) override

public byte[] DecryptKey (
    String algorithm, 
    byte[] keyData
)

public override function DecryptKey (
    algorithm : String, 
    keyData : byte[]
) : byte[]

Parameters

algorithm
Algorithm to use when decrypting the key.

keyData
Bytes representing the encrypted key.

Return Value

Decrypted bytes.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)