ISCardDatabase::ListReaders method
[The ListReaders 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 ListReaders method retrieves the names of the smart card readers registered in the smart card database.
Syntax
HRESULT ListReaders(
[in] LONG localeId,
[out] LPSAFEARRAY *ppReaders
);
Parameters
-
localeId [in]
-
Language localization ID.
-
ppReaders [out]
-
Pointer to a SAFEARRAY of BSTRs that contains the names of the smart card readers if successful; NULL if the operation failed.
Return value
The method returns one of the following possible values.
| Return code | Description |
|---|---|
|
Operation completed successfully. |
|
Invalid parameter. |
|
A bad pointer was passed in ppReaders. |
|
Out of memory. |
Remarks
To retrieve all known smart cards or reader groups, call ListCards or ListReaderGroups 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 smart card readers registered in the smart card database.
LPSAFEARRAY pReaders = NULL;
HRESULT hr;
// Determine the reader groups.
hr = pISCDataBase->ListReaders(0x0409, // English (US)
&pReaders);
if (FAILED(hr))
{
printf("Failed ListReaders\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 |
|
| Type library |
|
| DLL |
|
| IID |
IID_ISCardDatabase is defined as 1461AAC8-6810-11D0-918F-00AA00C18068 |
See also