This documentation is archived and is not being maintained.

CspKeyContainerInfo Class

Provides additional information about a cryptographic key pair. This class cannot be inherited.


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

type CspKeyContainerInfo =  class end

The CspKeyContainerInfo type exposes the following members.

Public methodCspKeyContainerInfoInitializes a new instance of the CspKeyContainerInfo class using the specified parameters.

Public propertyAccessibleGets a value indicating whether a key in a key container is accessible.
Public propertyCryptoKeySecurityGets a CryptoKeySecurity object that represents access rights and audit rules for a container.
Public propertyExportableGets a value indicating whether a key can be exported from a key container.
Public propertyHardwareDeviceGets a value indicating whether a key is a hardware key.
Public propertyKeyContainerNameGets a key container name.
Public propertyKeyNumberGets a value that describes whether an asymmetric key was created as a signature key or an exchange key.
Public propertyMachineKeyStoreGets a value indicating whether a key is from a machine key set.
Public propertyProtectedGets a value indicating whether a key pair is protected.
Public propertyProviderNameGets the provider name of a key.
Public propertyProviderTypeGets the provider type of a key.
Public propertyRandomlyGeneratedGets a value indicating whether a key container was randomly generated by a managed cryptography class.
Public propertyRemovableGets a value indicating whether a key can be removed from a key container.
Public propertyUniqueKeyContainerNameGets a unique key container name.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Use this class to obtain additional information about a key pair, such as the key container name or the key number.

In cases where a random key is generated by the RSACryptoServiceProvider or the DSACryptoServiceProvider, a key container will not be created until you call a method that uses the key. Some properties of the CspKeyContainerInfo class will throw a CryptographicException if a key container has not been created.

The following code example creates a key container and retrieves information about that container.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

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