CngKey::Open Method (String^, CngProvider^, CngKeyOpenOptions)

 

Creates an instance of an CngKey object that represents an existing named key, using the specified key storage provider (KSP) and key open options.

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

public:
static CngKey^ Open(
	String^ keyName,
	CngProvider^ provider,
	CngKeyOpenOptions openOptions
)

Parameters

keyName
Type: System::String^

The name of the key.

provider
Type: System.Security.Cryptography::CngProvider^

The KSP that contains the key.

openOptions
Type: System.Security.Cryptography::CngKeyOpenOptions

A bitwise combination of the enumeration values that specify options for opening the key, such as where the key is opened from (machine or user storage) and whether to suppress UI prompting.

Return Value

Type: System.Security.Cryptography::CngKey^

An existing key.

Exception Condition
ArgumentNullException

keyName or provider is null.

PlatformNotSupportedException

Cryptography Next Generation (CNG) is not supported on this system.

CryptographicException

All other errors.

Unlike the Open(String^) method overload, this overload lets you specify both the provider and the key open options.

KeyContainerPermissionAccessEntryCollection

for permission to open a key container. Demand value: Demand. Associated enumeration: KeyContainerPermissionFlags::Open

.NET Framework
Available since 3.5
Return to top
Show: