CryptDestroyHash 1.ODSQO

[New - Windows NT]

[New - Windows 95, OEM Service Release 2]

The CryptDestroyHash 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.

BOOL CRYPTFUNC CryptDestroyHash(

HCRYPTHASH hHash
);

Parameters

hHash

[in] A handle to the hash object to be destroyed.

Remarks

When a hash object is destroyed, the 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 correspondence between calls to CryptCreateHash4HQ3.7 and CryptDestroyHash.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To retrieve extended error information, use the GetLastError11C2VS7 function.

The following table lists the error codes most commonly returned by the GetLastError function. The error codes prefaced by NTE are generated by the particular CSP you are using.

Error	Description
ERROR_BUSY	The hash object specified by hHash is currently being used by another process.
ERROR_INVALID_HANDLE	One of the parameters specifies an invalid handle.
ERROR_INVALID_PARAMETER	One of the parameters contains an invalid value. This is most often an illegal pointer.
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.

Example

See the Example section in the CryptSignHash function.