BCryptDestroyHash

The BCryptDestroyHash function destroys a hash or Message Authentication Code (MAC) object.

Syntax

NTSTATUS BCryptDestroyHash(
         BCRYPT_HASH_HANDLE hHash
)  

Parameters

hHash
Type: BCRYPT_HASH_HANDLE 

[in, out] The handle of the hash or MAC object to destroy. This handle is obtained by using the BCryptCreateHash function.

Return value

Type: NTSTATUS 

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

Return codes

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

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

Remarks

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

Requirements

Header: Declared in bcrypt.h.

Library: Use bcrypt.lib.