This documentation is archived and is not being maintained.

CngKeyCreationParameters Class

Contains advanced properties for key creation.


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

[HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort = true)]
public sealed class CngKeyCreationParameters

The CngKeyCreationParameters type exposes the following members.

Public methodCngKeyCreationParametersInitializes a new instance of the CngKeyCreationParameters class.

Public propertyExportPolicyGets or sets the key export policy.
Public propertyKeyCreationOptionsGets or sets the key creation options.
Public propertyKeyUsageGets or sets the cryptographic operations that apply to the current key.
Public propertyParametersEnables a CngKey object to be created with additional properties that are set before the key is finalized.
Public propertyParentWindowHandleGets or sets the window handle that should be used as the parent window for dialog boxes that are created by Cryptography Next Generation (CNG) classes.
Public propertyProviderGets or sets the key storage provider (KSP) to create a key in.
Public propertyUIPolicyGets or sets information about the user interface to display when a key is created or accessed.

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

CngKey objects contain properties. Some properties must be added to a key when it is created. Other properties can be added after the key is created.

The CngKeyCreationParameters class enables you to add properties to a key as it is being created. You can do this by passing a CngKeyCreationParameters object that contains standard key properties, such as key storage provider (KSP), export policy, key usage, user interface (UI) policy, and parent window handle, to the Create method. The CngKey object that is being created will be initialized with these values before it is finalized.

You can also add non-standard properties to a key by using the Parameters property.

If you need to add properties after a key is created, use the SetProperty method.


The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later)

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.