CspParameters Class

CspParameters Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Contains parameters that are passed to the cryptographic service provider (CSP) that performs cryptographic computations. This class cannot be inherited.


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

public sealed class CspParameters

The CspParameters type exposes the following members.

Public methodCspParameters()Initializes a new instance of the CspParameters class.
Public methodCspParameters(Int32)Initializes a new instance of the CspParameters class with the specified provider type code.
Public methodCspParameters(Int32, String)Initializes a new instance of the CspParameters class with the specified provider type code and name.
Public methodCspParameters(Int32, String, String)Initializes a new instance of the CspParameters class with the specified provider type code and name, and the specified container name.

Public propertyFlagsRepresents the flags for CspParameters that modify the behavior of the cryptographic service provider (CSP).

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 the Object 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.)

Public fieldKeyContainerNameRepresents the key container name for CspParameters.
Public fieldKeyNumberSpecifies whether an asymmetric key is created as a signature key or an exchange key.
Public fieldProviderNameRepresents the provider name for CspParameters.
Public fieldProviderTypeRepresents the provider type code for CspParameters.

The CspParameters class represents parameters that you can pass to managed cryptography classes that internally use Microsoft Cryptographic Service Providers (CSPs) from the unmanaged Microsoft Cryptography API (CAPI). Classes with names ending in "CryptoServiceProvider" are managed code wrappers for the corresponding CSP.

Use the CspParameters class to do the following:

  • Specify a particular CSP by passing the provider type to the ProviderType or ProviderName property. You can also specify a CSP using an overload of the constructor.

  • Create a key container where you can store cryptographic keys. Key containers provide the most secure way to persist cryptographic keys and keep them secret from malicious third parties.

  • Specify whether to create an asymmetric signature key or an asymmetric exchange key using the KeyNumber property.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1

Windows Phone

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

© 2017 Microsoft