CardDestroyDHAgreement function

This topic is not current. For the most current information about the Smart Card API, see Smart Card Minidriver Specification.

The CardDestroyDHAgreement function, defined by a smart card module, removes a Diffie-Hellman secret agreement from the specified key container on the smart card.

Syntax

DWORD WINAPI CardDestroyDHAgreement(
  _In_ PCARD_DATA pCardData,
  _In_ BYTE       bSecretAgreementIndex,
  _In_ DWORD      dwFlags
);

Parameters

pCardData [in]

A pointer to a CARD_DATA structure received from a call to the CardAcquireContext function.

bSecretAgreementIndex [in]

The index of the key container that contains the secret agreement to be removed.

dwFlags [in]

Reserved. This parameter must be set to zero.

Return value

If the function succeeds, the function returns zero.

If the function fails, it returns a nonzero value.

Requirements

Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Header	Cardmod.h