CardDestroyDHAgreement Function

  • Article

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
Minimum supported server Windows Server 2008
Header Cardmod.h

Send comments about this topic to Microsoft

Build date: 3/5/2009