Поделиться через


Функция SCardListReadersW (winscard.h)

Функция SCardListReaders предоставляет список читателей, в наборе именованных групп чтения , что устраняет повторяющиеся элементы.

Вызывающий объект предоставляет список групп чтения и получает список читателей в именованных группах. Нераспознанные имена групп игнорируются. Эта функция возвращает только средства чтения в именованных группах, которые в настоящее время подключены к системе и доступны для использования.

Синтаксис

LONG SCardListReadersW(
  [in]           SCARDCONTEXT hContext,
  [in, optional] LPCWSTR      mszGroups,
  [out]          LPWSTR       mszReaders,
  [in, out]      LPDWORD      pcchReaders
);

Параметры

[in] hContext

Дескриптор, определяющий контекст диспетчера ресурсов для запроса. Контекст диспетчера ресурсов можно задать с помощью предыдущего вызова SCardEstablishContext.

Если для этого параметра задано значение NULL, поиск средств чтения не ограничивается контекстом.

[in, optional] mszGroups

Имена групп чтения, определенных в системе, в виде нескольких строк. Используйте значение NULL для перечисления всех читателей в системе (то есть группы SCard$AllReaders).

Ценность Значение
SCARD_ALL_READERS
TEXT("SCard$AllReaders\000")
Группа используется, если имя группы не указано при перечислении читателей. Возвращает список всех читателей, независимо от того, в какой группе или группах находятся читатели.
SCARD_DEFAULT_READERS
TEXT("SCard$DefaultReaders\000")
Группа по умолчанию, к которой добавляются все читатели при вводе в систему.
SCARD_LOCAL_READERS
TEXT("SCard$LocalReaders\000")
Неиспользуемое устаревшее значение. Это внутренняя управляемая группа, которая не может быть изменена с помощью api группы чтения. Он предназначен только для перечисления.
SCARD_SYSTEM_READERS
TEXT("SCard$SystemReaders\000")
Неиспользуемое устаревшее значение. Это внутренняя управляемая группа, которая не может быть изменена с помощью api группы чтения. Он предназначен только для перечисления.

[out] mszReaders

С несколькими строками, которые перечисляют средства чтения карт в указанных группах чтения. Если это значение равно NULL, SCardListReaders игнорирует длину буфера, указанную в pcchReaders, записывает длину буфера, который был бы возвращен, если этот параметр не был null в pcchReadersи возвращает код успешности.

[in, out] pcchReaders

Длина буфера mszReaders в символах. Этот параметр получает фактическую длину многостроевой структуры, включая все конечные символы null. Если длина буфера указана как SCARD_AUTOALLOCATE, то mszReaders преобразуется в указатель на байтовый указатель и получает адрес блока памяти, содержащего многострочной структуры. Этот блок памяти должен быть освобожден с SCardFreeMemory.

Возвращаемое значение

Эта функция возвращает разные значения в зависимости от того, выполнена ли она успешно или завершается сбоем.

Возврат кода или значения Описание
успех
0 (0x0)
SCARD_S_SUCCESS
Группа не содержит читателей
2148532270 (0x8010002E)
SCARD_E_NO_READERS_AVAILABLE
Указанное средство чтения в настоящее время недоступно для использования
2148532247 (0x80100017)
SCARD_E_READER_UNAVAILABLE
Другие
Код ошибки. Дополнительные сведения см. в возвращаемых значений смарт-карт.

Замечания

Функция SCardListReaders — это функция запроса базы данных. Дополнительные сведения о других функциях запросов к базе данных см. в функции запросов к базе данных смарт-карт.

Примеры

В следующем примере показан список читателей.

LPTSTR          pmszReaders = NULL;
LPTSTR          pReader;
LONG            lReturn, lReturn2;
DWORD           cch = SCARD_AUTOALLOCATE;

// Retrieve the list the readers.
// hSC was set by a previous call to SCardEstablishContext.
lReturn = SCardListReaders(hSC,
                           NULL,
                           (LPTSTR)&pmszReaders,
                           &cch );
switch( lReturn )
{
    case SCARD_E_NO_READERS_AVAILABLE:
        printf("Reader is not in groups.\n");
        // Take appropriate action.
        // ...
        break;

    case SCARD_S_SUCCESS:
        // Do something with the multi string of readers.
        // Output the values.
        // A double-null terminates the list of values.
        pReader = pmszReaders;
        while ( '\0' != *pReader )
        {
            // Display the value.
            printf("Reader: %S\n", pReader );
            // Advance to the next value.
            pReader = pReader + wcslen((wchar_t *)pReader) + 1;
        }
        // Free the memory.
        lReturn2 = SCardFreeMemory( hSC,
                                   pmszReaders );
        if ( SCARD_S_SUCCESS != lReturn2 )
            printf("Failed SCardFreeMemory\n");
        break;

default:
        printf("Failed SCardListReaders\n");
        // Take appropriate action.
        // ...
        break;
}

Заметка

Заголовок winscard.h определяет SCardListReaders в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора UNICODE. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование Ценность
минимальные поддерживаемые клиентские Windows XP [только классические приложения]
минимальный поддерживаемый сервер Windows Server 2003 [только классические приложения]
целевая платформа Виндоус
заголовка winscard.h
библиотеки Winscard.lib
DLL Winscard.dll

См. также

SCardEstablishContext

SCardFreeMemory

SCardGetProviderId

SCardListCards

SCardListInterfaces

SCardListReaderGroups