CardConstructDHAgreement function

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

The CardConstructDHAgreement function, defined by a smart card module, performs a secret agreement calculation for Diffie-Hellman key exchange by using the specified private key.

Windows Server 2003, Windows XP, Windows 2000 Server and Windows 2000 Professional: This function is not supported.

Syntax

DWORD WINAPI CardConstructDHAgreement(
  _In_ PCARD_DATA              pCardData,
  _In_ PCARD_DH_AGREEMENT_INFO pAgreementInfo
);

Parameters

pCardData [in]

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

pAgreementInfo [in]

A pointer to a CARD_DH_AGREEMENT_INFO structure that, on input, specifies the index of the container that contains the keys to exchange. On output, the structure contains a handle to the calculated secret agreement.

Return value

If the function succeeds, it returns zero.

If the function fails, it returns a nonzero error value.

Requirements

Minimum supported client
Windows XP [desktop apps only]
Minimum supported server
Windows Server 2003 [desktop apps only]
Header
Cardmod.h

See also

Microsoft Base Smart Card Cryptographic Service Provider