PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_FREE_IDENTIFIER callback function (wincrypt.h)

Article
02/22/2024

The PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_FREE_IDENTIFIER callback function releases memory for an object identifier.

Syntax

PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_FREE_IDENTIFIER PfnCryptObjectLocatorProviderFreeIdentifier;

void PfnCryptObjectLocatorProviderFreeIdentifier(
  [in, optional] LPVOID pPluginContext,
  [in]           PCRYPT_DATA_BLOB pIdentifier
)
{...}

Parameters

[in, optional] pPluginContext

Pointer to an optional buffer defined by this provider and returned by the PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_INITIALIZE function. The buffer is not modified by the caller. Your provider can use the data to help it determine what actions to perform or to maintain additional information.

[in] pIdentifier

Pointer to the buffer that contains the identifier.

Return value

None

Remarks

The PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_FREE_IDENTIFIER function is currently called by only the Secure Channel (Schannel) security package. This function may be called for any of the following reasons:

An error occurred when processing the object returned by the PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_GET function.
The object returned by PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_GET is no longer needed.
An updated object has been retrieved and the original object is no longer required.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	wincrypt.h