ISCardDatabase::ListCards method

Article
01/07/2021

[The ListCards method is available for use in the operating systems specified in the Requirements section. It is not available for use in Windows Server 2003 with Service Pack 1 (SP1) and later, Windows Vista, Windows Server 2008, and subsequent versions of the operating system. The Smart Card Modules provide similar functionality.]

The ListCards method retrieves all of the smart card names that match the specified interface identifiers (GUIDs), the specified ATR string, or both.

Syntax

HRESULT ListCards(
  [in]  LPBYTEBUFFER pAtr,
  [in]  LPSAFEARRAY  pInterfaceGuids,
  [in]  LONG         localeId,
  [out] LPSAFEARRAY  *ppCardNames
);

Parameters

pAtr [in]: Pointer to a smart card ATR string. The ATR string must be packaged into an IByteBuffer.
pInterfaceGuids [in]: Pointer to a SAFEARRAY of COM interface identifiers (GUIDs) in BSTR format.
localeId [in]: Language localization identifier.
ppCardNames [out]: Pointer to a SAFEARRAY of BSTRs that contains the names of the smart cards that satisfied the search parameters if successful; NULL if the operation failed.

Return value

The method returns one of the following possible values.

Return code	Description
S_OK	Operation completed successfully.
E_INVALIDARG	Invalid parameter.
E_POINTER	A bad pointer was passed in.
E_OUTOFMEMORY	Out of memory.

Remarks

To retrieve all known readers or reader, call ListReaders or ListReaderGroups respectively.

To retrieve the primary service or the interfaces of a specific card GetProviderCardId or ListCardInterfaces respectively.

For a list of all the methods provided by this interface, see ISCardDatabase.

In addition to the COM error codes listed above, this interface may return a smart card error code if a smart card function was called to complete the request. For more information, see Smart Card Return Values.

Examples

The following example shows retrieving the smart card names that match the specified ATR string.

// Define or determine byAtr as needed for your ATR use.
BYTE byAtr[] = {0x3b,0x27,0x00,0x80,0x65,0xa2,0x0c,0x01,0x01,0x37};
LPSAFEARRAY pSafeArray = NULL;
HRESULT          hr;

// pIByteBuff is a pointer to an instance of IByteBuffer.
hr = pIByteBuff->Initialize(sizeof(byAtr), byAtr);

// Call the function for the specified ATR.
hr = pISCDataBase->ListCards(pIByteBuff,
                             NULL,
                             0,
                             &pSafeArray);
if (FAILED(hr))
{
   printf("Failed ListCards\n");
   // Take other error handling action as needed.
}
else
{
   // Use the safe array as needed.
}

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
End of client support	Windows XP
End of server support	Windows Server 2003
Header	Scardmgr.h
Type library	Scardmgr.tlb
DLL	Scardssp.dll
IID	IID_ISCardDatabase is defined as 1461AAC8-6810-11D0-918F-00AA00C18068

Share via