CngKey.Exists Method
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Checks for a named key in a specific key storage provider(KSP).
| Exists(String) |
Checks to see whether a named key exists in the default key storage provider (KSP). |
| Exists(String, CngProvider) |
Checks to see whether a named key exists in the specified key storage provider (KSP). |
| Exists(String, CngProvider, CngKeyOpenOptions) |
Checks to see whether a named key exists in the specified key storage provider (KSP), according to the specified options. |
- Source:
- Cng.NotSupported.cs
- Source:
- Cng.NotSupported.cs
- Source:
- Cng.NotSupported.cs
Checks to see whether a named key exists in the default key storage provider (KSP).
public:
static bool Exists(System::String ^ keyName);[System.Runtime.Versioning.SupportedOSPlatform("windows")]
public static bool Exists(string keyName);public static bool Exists(string keyName);[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]
static member Exists : string -> boolstatic member Exists : string -> boolPublic Shared Function Exists (keyName As String) As BooleanParameters
- keyName
- String
The key name.
Returns
true if the named key exists in the default KSP; otherwise, false.
- Attributes
Exceptions
keyName is null.
Cryptography Next Generation (CNG) is not supported on this system.
All other errors.
Remarks
The default KSP is MicrosoftSoftwareKeyStorageProvider.
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .NET | Core 1.0, Core 1.1, 6, 7, 8, 9, 10 |
| .NET Framework | 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| .NET Standard | 2.0 (package-provided), 2.1 (package-provided) |
| Windows Desktop | 3.0, 3.1, 5 |
- Source:
- Cng.NotSupported.cs
- Source:
- Cng.NotSupported.cs
- Source:
- Cng.NotSupported.cs
Checks to see whether a named key exists in the specified key storage provider (KSP).
public:
static bool Exists(System::String ^ keyName, System::Security::Cryptography::CngProvider ^ provider);[System.Runtime.Versioning.SupportedOSPlatform("windows")]
public static bool Exists(string keyName, System.Security.Cryptography.CngProvider provider);public static bool Exists(string keyName, System.Security.Cryptography.CngProvider provider);[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]
static member Exists : string * System.Security.Cryptography.CngProvider -> boolstatic member Exists : string * System.Security.Cryptography.CngProvider -> boolPublic Shared Function Exists (keyName As String, provider As CngProvider) As BooleanParameters
- keyName
- String
The key name.
- provider
- CngProvider
The KSP to check for the key.
Returns
true if the named key exists in the specified provider; otherwise, false.
- Attributes
Exceptions
keyName or provider is null.
Cryptography Next Generation (CNG) is not supported on this system.
All other errors.
Remarks
Use this overload to check for the existence of a key in a KSP other than the default KSP, which is MicrosoftSoftwareKeyStorageProvider.
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .NET | Core 1.0, Core 1.1, 6, 7, 8, 9, 10 |
| .NET Framework | 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| .NET Standard | 2.0 (package-provided), 2.1 (package-provided) |
| Windows Desktop | 3.0, 3.1, 5 |
- Source:
- Cng.NotSupported.cs
- Source:
- Cng.NotSupported.cs
- Source:
- Cng.NotSupported.cs
Checks to see whether a named key exists in the specified key storage provider (KSP), according to the specified options.
public:
static bool Exists(System::String ^ keyName, System::Security::Cryptography::CngProvider ^ provider, System::Security::Cryptography::CngKeyOpenOptions options);[System.Runtime.Versioning.SupportedOSPlatform("windows")]
public static bool Exists(string keyName, System.Security.Cryptography.CngProvider provider, System.Security.Cryptography.CngKeyOpenOptions options);public static bool Exists(string keyName, System.Security.Cryptography.CngProvider provider, System.Security.Cryptography.CngKeyOpenOptions options);[System.Security.SecurityCritical]
public static bool Exists(string keyName, System.Security.Cryptography.CngProvider provider, System.Security.Cryptography.CngKeyOpenOptions options);[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]
static member Exists : string * System.Security.Cryptography.CngProvider * System.Security.Cryptography.CngKeyOpenOptions -> boolstatic member Exists : string * System.Security.Cryptography.CngProvider * System.Security.Cryptography.CngKeyOpenOptions -> bool[<System.Security.SecurityCritical>]
static member Exists : string * System.Security.Cryptography.CngProvider * System.Security.Cryptography.CngKeyOpenOptions -> boolPublic Shared Function Exists (keyName As String, provider As CngProvider, options As CngKeyOpenOptions) As BooleanParameters
- keyName
- String
The key name.
- provider
- CngProvider
The KSP to search for the key.
- options
- CngKeyOpenOptions
A bitwise combination of the enumeration values that specify options for opening a key.
Returns
true if the named key exists in the specified provider; otherwise, false.
- Attributes
Exceptions
keyName or provider is null.
Cryptography Next Generation (CNG) is not supported on this system.
All other errors.
Remarks
Use this overload to check for the existence of a key in a KSP other than the default MicrosoftSoftwareKeyStorageProvider, and to specify key open options.
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .NET | Core 1.0, Core 1.1, 6, 7, 8, 9, 10 |
| .NET Framework | 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| .NET Standard | 2.0 (package-provided), 2.1 (package-provided) |
| Windows Desktop | 3.0, 3.1, 5 |
.NET feedback
.NET is an open source project. Select a link to provide feedback: