EncryptingCredentials Constructor (SecurityKey, SecurityKeyIdentifier, String)

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

Initializes a new instance of the EncryptingCredentials class with the specified cryptographic key, key identifier, and encryption algorithm.

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

Usage

'Usage
Dim key As SecurityKey
Dim keyIdentifier As SecurityKeyIdentifier
Dim algorithm As String

Dim instance As New EncryptingCredentials(key, keyIdentifier, algorithm)

Syntax

'Declaration
Public Sub New ( _
    key As SecurityKey, _
    keyIdentifier As SecurityKeyIdentifier, _
    algorithm As String _
)

public EncryptingCredentials (
    SecurityKey key,
    SecurityKeyIdentifier keyIdentifier,
    string algorithm
)

public:
EncryptingCredentials (
    SecurityKey^ key, 
    SecurityKeyIdentifier^ keyIdentifier, 
    String^ algorithm
)

public EncryptingCredentials (
    SecurityKey key, 
    SecurityKeyIdentifier keyIdentifier, 
    String algorithm
)

public function EncryptingCredentials (
    key : SecurityKey, 
    keyIdentifier : SecurityKeyIdentifier, 
    algorithm : String
)

Parameters

key
A SecurityKey that contains the cryptographic key that is used for encryption.

keyIdentifier
A SecurityKeyIdentifier that specifies the identifier that represents the key that is used for encryption.

algorithm
A URI that represents the cryptographic algorithm that is used for encryption.

Exceptions

Exception type	Condition
ArgumentNullException	key is null. -or- key identifier is null. -or- algorithm is null.

ArgumentNullException

key is null.

-or-

key identifier is null.

-or-

algorithm is null.

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)