ISCardDatabase::ListReaderGroups method

[The ListReaderGroups 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 ListReaderGroups method retrieves the names of the reader groups registered in the smart card database.

Syntax

HRESULT ListReaderGroups(
  [in]  LONG        localeId,
  [out] LPSAFEARRAY *ppReaderGroups
);

Parameters

localeId [in]

Language localization ID.

ppReaderGroups [out]

Pointer to a SAFEARRAY of BSTRs that contains the names of the smart card reader groups that satisfied the search parameters if successful; NULL if the operation failed.

Return value

The method returns one of the following possible values.

Remarks

To retrieve all known smart cards or readers, call ListCards or ListReaders respectively.

To retrieve the primary service provider 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 names of the reader groups registered in the smart card database.

LPSAFEARRAY pGroups = NULL;
HRESULT     hr;

// Determine the reader groups.
hr = pISCDataBase->ListReaderGroups(0x0409,  // English (US)
                                    &pGroups);
if (FAILED(hr))
{
   printf("Failed ListReaderGroups\n");
   // Take other error handling action as needed.
}
else
{
   // Use the safe array as needed.
   // ...
}

Requirements

See also

GetProviderCardId

ISCardDatabase

ListCardInterfaces

ListCards

ListReaders