BCryptDestroyKey function

The BCryptDestroyKey function destroys a key.

Syntax

NTSTATUS BCryptDestroyKey(
  BCRYPT_KEY_HANDLE hKey
);

Parameters

hKey

The handle of the key to destroy.

Return Value

Returns a status code that indicates the success or failure of the function.

Possible return codes include, but are not limited to, the following.

Return code Description
STATUS_SUCCESS
The function was successful.
STATUS_INVALID_HANDLE
The key handle in the hKey parameter is not valid.

Remarks

Depending on what processor modes a provider supports, BCryptDestroyKey can be called either from user mode or kernel mode. Kernel mode callers can execute either at PASSIVE_LEVEL IRQL or DISPATCH_LEVEL IRQL. If the current IRQL level is DISPATCH_LEVEL, the handle provided in the hKey parameter must be derived from an algorithm handle returned by a provider that was opened with the BCRYPT_PROV_DISPATCH flag.

To call this function in kernel mode, use Cng.lib, which is part of the Driver Development Kit (DDK). Windows Server 2008 and Windows Vista:  To call this function in kernel mode, use Ksecdd.lib.

Requirements

   
Minimum supported client Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header bcrypt.h
Library Bcrypt.lib
DLL Bcrypt.dll

See Also

BCryptGenerateKeyPair

BCryptGenerateSymmetricKey

BCryptImportKey

BCryptImportKeyPair