This documentation is archived and is not being maintained.

DSACryptoServiceProvider.CspKeyContainerInfo Property

Gets a CspKeyContainerInfo object that describes additional information about a cryptographic key pair.

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

public CspKeyContainerInfo CspKeyContainerInfo { get; }

Property Value

Type: System.Security.Cryptography.CspKeyContainerInfo
A CspKeyContainerInfo object that describes additional information about a cryptographic key pair.



Use the CspKeyContainerInfo property to retrieve additional information about a cryptographic key pair. The returned CspKeyContainerInfo object describes whether the key is exportable, and specifies the key container name, information about the provider, and other information.

In cases where a random key is generated, a key container will not be created until you call a method that uses the key. Some properties of the CspKeyContainerInfo object returned by the CspKeyContainerInfo property will throw a CryptographicException if a key container has not been created. To make sure that a key container has been created, call a method such as SignData, SignHash, VerifyData, VerifyHash, and so on, before you call the CspKeyContainerInfo property.

The following code example demonstrates how to call the CspKeyContainerInfo property.

using System;
using System.Security.Cryptography;
using System.Text;

public class CspKeyContainerInfoExample

    public static void Main(String[] args)
        DSACryptoServiceProvider dsa= new DSACryptoServiceProvider();

            // Note: In cases where a random key is generated,    
            // a key container is not created until you call   
            // a method that uses the key.  This example calls 
            // the SignData method before calling the 
            // CspKeyContainerInfo property so that a key 
            // container is created.   

            // Create some data to encrypt and display it.
            string data = "Here is some data to sign.";

            Console.WriteLine("Data to sign: " + data);

            // Convert the data to an array of bytes and  
            // encrypt it.
            byte[] byteData = Encoding.ASCII.GetBytes(data);

            byte[] sData = dsa.SignData(byteData, 0, byteData.Length);

            // Display the encrypted value.
            Console.WriteLine("Signed Data: " + Encoding.ASCII.GetString(sData));


            Console.WriteLine("CspKeyContainerInfo information:");


            // Create a new CspKeyContainerInfo object.
            CspKeyContainerInfo keyInfo = dsa.CspKeyContainerInfo;

            // Display the value of each property.

            Console.WriteLine("Accessible property: " + keyInfo.Accessible);

            Console.WriteLine("Exportable property: " + keyInfo.Exportable);

            Console.WriteLine("HardwareDevice property: " + keyInfo.HardwareDevice);

            Console.WriteLine("KeyContainerName property: " + keyInfo.KeyContainerName);

            Console.WriteLine("KeyNumber property: " + keyInfo.KeyNumber.ToString());

            Console.WriteLine("MachineKeyStore property: " + keyInfo.MachineKeyStore);

            Console.WriteLine("Protected property: " + keyInfo.Protected);

            Console.WriteLine("ProviderName property: " + keyInfo.ProviderName);

            Console.WriteLine("ProviderType property: " + keyInfo.ProviderType);

            Console.WriteLine("RandomlyGenerated property: " + keyInfo.RandomlyGenerated);

            Console.WriteLine("Removable property: " + keyInfo.Removable);

            Console.WriteLine("UniqueKeyContainerName property: " + keyInfo.UniqueKeyContainerName);

        catch (Exception e)
            // Clear the key.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0