This documentation is archived and is not being maintained.

KeyedHashAlgorithm.Key Property

Gets or sets the key to use in the hash algorithm.

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

virtual property array<unsigned char>^ Key {
	array<unsigned char>^ get ();
	void set (array<unsigned char>^ value);
/** @property */
public byte[] get_Key ()

/** @property */
public void set_Key (byte[] value)

public function get Key () : byte[]

public function set Key (value : byte[])

Property Value

The key to use in the hash algorithm.

Exception typeCondition


An attempt was made to change the Key property after hashing has begun.

This property is the public accessor for the KeyValue field.

The following code example demonstrates how to override the Key property to retrieve the key used in the current KeyedHashAlgorithm object. This code example is part of a larger example provided for the KeyedHashAlgorithm class.

   virtual array<Byte>^ get() override
      return dynamic_cast<array<Byte>^>(keyedCrypto->Key->Clone());

   virtual void set( array<Byte>^value ) override
      keyedCrypto->Key = dynamic_cast<array<Byte>^>(value->Clone());

/** @property 
public ubyte[] get_Key()
    return (ubyte[])keyedCrypto.get_Key().Clone();
} //get_Key

/** @property 
public void set_Key(ubyte value[])
} //set_Key

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0