CardGetContainerInfo function

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

The CardGetContainerInfo function, defined by a smart card module, retrieves a CONTAINER_INFO structure that contains information about a key container on a smart card.

Syntax

DWORD WINAPI CardGetContainerInfo(
  _In_    PCARD_DATA      pCardData,
  _In_    BYTE            bContainerIndex,
  _In_    DWORD           dwFlags,
  _Inout_ PCONTAINER_INFO pContainerInfo
);

Parameters

pCardData [in]

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

bContainerIndex [in]

A BYTE value that specifies the index number for the key container for which to get information. The Microsoft Base Smart Card Cryptographic Service Provider (CSP) and smart card key storage provider (KSP) use this index value to identify the key container.

The function fails if the specified key container does not exist.

dwFlags [in]

Reserved. This parameter must be set to zero.

pContainerInfo [in, out]

A CONTAINER_INFO structure that, on output, contains information about the key container specified by the bContainerIndex parameter.

Return value

If the function succeeds, the function returns zero.

If the function fails, it returns a nonzero error value or one of the following possible error values.

Requirements

See also

CARD_DATA

CardAcquireContext

CardCreateContainer

CONTAINER_INFO