Função SCardGetReaderIconA (winscard.h)

Artigo
11/20/2024

A função SCardGetReaderIcon obtém um ícone do leitor de cartão inteligente para o nome de um determinado leitor. Essa função não afeta o estado do leitor de cartão.

Sintaxe

LONG SCardGetReaderIconA(
  [in]      SCARDCONTEXT hContext,
  [in]      LPCSTR       szReaderName,
  [out]     LPBYTE       pbIcon,
  [in, out] LPDWORD      pcbIcon
);

Parâmetros

[in] hContext

Identificador que identifica o contexto do gerenciador de recursos para a consulta. Você pode definir o contexto do gerenciador de recursos por uma chamada anterior para a função SCardEstablishContext. Esse parâmetro não pode ser NULL.

[in] szReaderName

Nome do leitor. Você pode obter esse valor chamando a função SCardListReaders.

[out] pbIcon

Ponteiro para um buffer que contém um BLOB do ícone de leitor de cartão inteligente como lido do arquivo de ícone. Se esse valor for NULL, a função ignorará o comprimento do buffer fornecido no parâmetro pcbIcon, gravará o comprimento do buffer que teria sido retornado para pcbIcon se esse parâmetro não tivesse sido NULL e retornaria um código de êxito.

[in, out] pcbIcon

Comprimento, em caracteres, do buffer de pbIcon. Esse parâmetro recebe o comprimento real do atributo recebido. Se o comprimento do buffer for especificado como SCARD_AUTOALLOCATE, pbIcon será convertido de um ponteiro para um ponteiro de bytes e receberá o endereço de um bloco de memória que contém o atributo. Esse bloco de memória deve ser desalocado com a função SCardFreeMemory .

Valor de retorno

Essa função retorna valores diferentes dependendo se ela é bem-sucedida ou falha.

Código de retorno	Descrição
de sucesso do	SCARD_S_SUCCESS.
de falha do	Um código de erro. Para obter mais informações, consulte valores de retorno de cartão inteligente.

Observações

O ícone deve ter 256 × 256 pixels sem canal alfa.

Exemplos

PBYTE    pbIcon = NULL;
DWORD    cbIcon = SCARD_AUTOALLOCATE;
DWORD    i;
LONG     lReturn;
LPTSTR   szReaderName = "USB Smart Card Reader 0";

// Retrieve the reader's icon.
// hContext was set by a previous call to SCardEstablishContext.
lReturn = SCardGetReaderIcon(hContext,
                         szReaderName,
                         (PBYTE)&pbIcon,
                         &cbIcon);

if ( SCARD_S_SUCCESS != lReturn )
{
    printf("Failed SCardGetReaderIcon - %x\n", lReturn);
    // Take appropriate action.
}
else
{
    // Free the memory when done. 
    lReturn = SCardFreeMemory(hContext, pbIcon);
}

Nota

O cabeçalho winscard.h define SCardGetReaderIcon como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 8 [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows Server 2012 [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	winscard.h

Compartilhar via