CryptDestroyHash (Compact 2013)

Article
08/12/2016

3/28/2014

This function destroys the hash object referenced by the hHash parameter. Once a hash object has been destroyed, it can no longer be used and its handle is useless from then on.

All hash objects should be destroyed with the CryptDestroyHash function when the application is finished with them.

Syntax

BOOL CRYPTFUNC CryptDestroyHash( 
  HCRYPTHASH hHash
);

Parameters

hHash
[in] HCRYPTHASH handle to the hash object to be destroyed.

Return Value

TRUE indicates success. FALSE indicates failure. To get extended error information, call the GetLastError function.

The following table shows the common values for the GetLastError function. The error values prefaced by NTE are generated by the particular cryptographic service provider (CSP) you are using.

Value	Description
ERROR_BUSY	The hash object specified by hHash is currently being used by another process.
ERROR_INVALID_HANDLE	The hHash parameter specifies an invalid handle.
ERROR_INVALID_PARAMETER	The hHash parameter contains an invalid value.
NTE_BAD_ALGID	The hHash handle specifies an algorithm that this CSP does not support.
NTE_BAD_HASH	The hash object specified by the hHash parameter is invalid.
NTE_BAD_UID	The CSP context that was specified when the hash object was created cannot be found.

Remarks

When a hash object is destroyed, many CSPs will scrub the memory in the CSP where the hash object was held. The CSP memory is then freed.

There should be a one-to-one relationship between calls to the CryptCreateHash function and calls to the CryptDestroyHash function.

Example Code

See CryptHashSessionKey.

Requirements

Header	wincrypt.h
Library	coredll.lib