Edit

Share via


BCryptCloseAlgorithmProvider function (bcrypt.h)

The BCryptCloseAlgorithmProvider function closes a CNG algorithm provider.

Note: Callers targeting Windows 10 and later should consider using CNG Algorithm Pseudo-handles instead of opening and closing CNG algorithm providers. See remarks of the CNG Algorithm Pseudo-handle documentation for restrictions.

Syntax

NTSTATUS BCryptCloseAlgorithmProvider(
  [in, out] BCRYPT_ALG_HANDLE hAlgorithm,
  [in]      ULONG             dwFlags
);

Parameters

[in, out] hAlgorithm

A handle that represents the algorithm provider to close. This handle is obtained by calling the BCryptOpenAlgorithmProvider function.

[in] dwFlags

A set of flags that modify the behavior of this function. No flags are defined for this function.

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 algorithm handle specified by the hAlgorithm parameter is not valid, or is a pseudo-handle which cannot be closed.

Remarks

BCryptCloseAlgorithmProvider can be called either from user mode or kernel mode. Kernel mode callers must be executing at PASSIVE_LEVEL IRQL.

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

Requirement Value
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

BCryptOpenAlgorithmProvider

CNG Algorithm Pseudo-handles