PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_FREE callback function (wincrypt.h)

The PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_FREE callback function releases the object returned by the provider.

Syntax

PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_FREE PfnCryptObjectLocatorProviderFree;

void PfnCryptObjectLocatorProviderFree(
  [in, optional] LPVOID pPluginContext,
  [in]           PBYTE pbData
)
{...}

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] pbData

Pointer to the buffer to release.

Return value

None

Remarks

The PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_FREE function is currently called by only the Secure Channel (Schannel) security package. Schannel calls PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_GET to retrieve an object and then calls PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_FREE to remove the data returned by the PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_GET call from memory when it 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

See also

CRYPT_OBJECT_LOCATOR_PROVIDER_TABLE

PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_GET

PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_INITIALIZE