Função RasGetEapUserDataA (ras.h)

Artigo
11/20/2024

Use a função RasGetEapUserData para recuperar informações do Protocolo de Autenticação Extensível (EAP) específicas do usuário para a entrada da lista telefônica especificada.

Sintaxe

DWORD RasGetEapUserDataA(
  [in]      HANDLE hToken,
  [in]      LPCSTR pszPhonebook,
  [in]      LPCSTR pszEntry,
  [out]     BYTE   *pbEapData,
  [in, out] DWORD  *pdwSizeofEapData
);

Parâmetros

[in] hToken

Manipule para um token de acesso primário ou de representação que representa o usuário para o qual recuperar dados. Esse parâmetro pode ser NULL se a função for chamada de um processo já em execução no contexto do usuário.

[in] pszPhonebook

Ponteiro para uma cadeia de caracteres terminada em nulo que especifica o caminho completo do arquivo PBK (phone-book). Se esse parâmetro for NULL, a função usará a lista telefônica do sistema.

[in] pszEntry

Ponteiro para uma cadeia de caracteres terminada em nulo que especifica um nome de entrada existente.

[out] pbEapData

Ponteiro para um buffer que recebe os dados EAP recuperados para o usuário. O chamador deve alocar a memória para esse buffer. Se o buffer não for grande o suficiente, rasGetEapUserData retornará ERROR_BUFFER_TOO_SMALLe o parâmetro pdwSizeofEapData conterá o tamanho necessário.

[in, out] pdwSizeofEapData

Ponteiro para uma variável DWORD que, na entrada, especifica o tamanho do buffer apontado pelo parâmetro pbEapData.

Se o buffer especificado pelo parâmetro pbEapData não for grande o suficiente, pdwSizeofEapData receberá, na saída, o tamanho necessário.

Valor de retorno

Se a função for bem-sucedida, o valor retornado será ERROR_SUCCESS.

Se a função falhar, o valor retornado será um dos seguintes códigos de erro ou um valor de códigos de erro de roteamento e acesso remoto ou Winerror.h.

Valor	Significado
E_INVALIDARG	O parâmetro pdwSizeofEapData é NULL.
ERROR_BUFFER_TOO_SMALL	O buffer apontado por pbEapData é muito pequeno para receber os dados. O pdwSizeofEapData contém o tamanho necessário.
ERROR_CANNOT_OPEN_PHONEBOOK	RasGetEapUserData não pôde abrir o arquivo de lista telefônica especificado.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	RasGetEapUserData não pôde encontrar a entrada especificada na lista telefônica.
Outros	Use FormatMessage para recuperar a mensagem de erro do sistema que corresponde ao código de erro retornado.

Observações

Nota

O cabeçalho ras.h define RasGetEapUserData 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 2000 Professional [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	ras.h
biblioteca	Rasapi32.lib
de DLL	Rasapi32.dll

Consulte também

RASEAPINFO

rasSetEapUserData

Visão geral do RAS (Serviço de Acesso Remoto)

Funções do Serviço de Acesso Remoto

Compartilhar via