Função RasGetCustomAuthDataA (ras.h)

Artigo
11/20/2024

Use a função RasGetCustomAuthData para recuperar informações de autenticação específicas da conexão. Essas informações não são específicas para um usuário específico.

Sintaxe

DWORD RasGetCustomAuthDataA(
  [in]      LPCSTR pszPhonebook,
  [in]      LPCSTR pszEntry,
  [out]     BYTE   *pbCustomAuthData,
  [in, out] DWORD  *pdwSizeofCustomAuthData
);

Parâmetros

[in] pszPhonebook

Ponteiro para um cadeia de caracteresterminada nula 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 um cadeia de caracteresterminada nula que especifica um nome de entrada existente.

[out] pbCustomAuthData

Ponteiro para um buffer que recebe os dados de autenticação. O chamador deve alocar a memória para esse buffer. Se o buffer não for grande o suficiente, rasGetCustomAuthData retornará ERROR_BUFFER_TOO_SMALL e o parâmetro pdwSizeofEapData conterá o tamanho necessário.

[in, out] pdwSizeofCustomAuthData

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

Se o buffer especificado pelo parâmetro pbCustomAuthData 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 pdwSizeofCustomAuthData é NULL.
ERROR_BUFFER_TOO_SMALL	O buffer apontado por pbCustomAuthData é muito pequeno para receber os dados. O pdwSizeofCustomAuthData 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 RasGetCustomAuthData 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

rasGetEapUserData

rasSetCustomAuthData

Compartilhar via