Share via


SymmetricAlgorithm.Key Property

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Gets or sets the secret key for the symmetric algorithm.

Namespace:  System.Security.Cryptography
Assembly:  mscorlib (in mscorlib.dll)

Syntax

'Declaration
Public Overridable Property Key As Byte()
public virtual byte[] Key { get; set; }

Property Value

Type: array<System.Byte[]
The secret key to use for the symmetric algorithm.

Exceptions

Exception Condition
ArgumentNullException

An attempt was made to set the key to nulla null reference (Nothing in Visual Basic).

CryptographicException

The key size is invalid.

Remarks

The secret key is used both for encryption and for decryption. For a symmetric algorithm to be successful, the secret key must be known only to the sender and the receiver. The valid key sizes are specified by the particular symmetric algorithm implementation and are listed in the LegalKeySizes property.

If this property is nulla null reference (Nothing in Visual Basic) when it is used, the GenerateKey method is called to create a new random value.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.