PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_FREE_PASSWORD callback function (wincrypt.h)

The PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_FREE_PASSWORD callback function releases the password used to encrypt a personal information exchange (PFX) byte array.

Syntax

PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_FREE_PASSWORD PfnCryptObjectLocatorProviderFreePassword;

void PfnCryptObjectLocatorProviderFreePassword(
  [in, optional] LPVOID pPluginContext,
  [in]           PCWSTR pwszPassword
)
{...}

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

Null-terminated Unicode string that contains the password.

Return value

None

Remarks

The PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_FREE_PASSWORD function is currently called by only the Secure Channel (Schannel) security package. Schannel calls PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_GET to retrieve a PFX byte array and then calls PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_FREE_PASSWORD after the byte array has been processed but before calling the PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_FREE_IDENTIFIER function.

Requirements

See also

CRYPT_OBJECT_LOCATOR_PROVIDER_TABLE

PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_GET

PFN_CRYPT_OBJECT_LOCATOR_PROVIDER_INITIALIZE