Função RasGetEntryDialParamsA (ras.h)

Artigo
08/25/2023

A função RasGetEntryDialParams recupera as informações de conexão salvas pela última chamada bem-sucedida para a função RasDial ou RasSetEntryDialParams para uma entrada de catálogo telefônico especificada.

Sintaxe

DWORD RasGetEntryDialParamsA(
  [in]      LPCSTR           unnamedParam1,
  [in, out] LPRASDIALPARAMSA unnamedParam2,
  [out]     LPBOOL           unnamedParam3
);

Parâmetros

[in] unnamedParam1

Ponteiro para uma cadeia de caracteres terminada em nulo que especifica o caminho completo e o nome de arquivo de um arquivo de catálogo telefônico (PBK). Se esse parâmetro for NULL, a função usará o arquivo de catálogo telefônico padrão atual. O arquivo de catálogo telefônico padrão é aquele selecionado pelo usuário na folha de propriedades Preferências do Usuário da caixa de diálogo Rede Discada .

Windows Me/98/95: Esse parâmetro sempre deve ser NULL. A rede discada armazena entradas de catálogo telefônico no registro em vez de em um arquivo de catálogo telefônico.

[in, out] unnamedParam2

Ponteiro para uma estrutura RASDIALPARAMS .

Na entrada, o membro dwSize especifica o tamanho da estrutura RASDIALPARAMS e o membro szEntryName especifica uma entrada de catálogo telefônico válida.

Na saída, a estrutura recebe os parâmetros de conexão associados à entrada de catálogo telefônico especificada.

Observe que o membro szPhoneNumber da estrutura não recebe o número de telefone associado à entrada da lista telefônica. Para obter o número de telefone associado a uma entrada de catálogo telefônico, chame a função RasGetEntryProperties . Se szPhoneNumber for uma cadeia de caracteres vazia na estrutura RASDIALPARAMS passada para RasDial, RasDial usará o número de telefone armazenado na entrada da lista telefônica.

O membro szPassword da estrutura RASDIALPARAMS não retorna a senha real. Em vez disso, szPassword contém um identificador para a senha salva. Substitua esse identificador pela senha salva em chamadas subsequentes para RasSetEntryDialParams e RasDial. Quando apresentado com esse identificador, RasDial recupera e usa a senha salva. O valor desse identificador pode mudar em versões futuras do sistema operacional; não desenvolva código que dependa do conteúdo ou formato desse valor.

Windows NT e Windows Me/98/95: Não há suporte para o recurso de senha segura.

[out] unnamedParam3

Ponteiro para um sinalizador que indica se a função recuperou a senha associada ao nome de usuário para a entrada da lista telefônica. O parâmetro lpfPassword será TRUE se o sistema tiver salvo uma senha para a entrada especificada. Se o sistema não tiver nenhuma senha salva para essa entrada, lpfPassword seráFALSE.

Windows NT e Windows Me/98/95: A função define esse sinalizador como TRUE se a senha do usuário foi retornada no membro szPassword da estrutura RASDIALPARAMS apontada por lprasdialparams.

Valor retornado

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	Descrição
ERROR_BUFFER_INVALID	O ponteiro lprasdialparams ou lpfPassword é inválido ou o buffer lprasdialparams é inválido.
ERROR_CANNOT_OPEN_PHONEBOOK	A lista telefônica está corrompida ou está faltando componentes.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	A entrada da lista telefônica não existe.

Comentários

Observação

O cabeçalho ras.h define RasGetEntryDialParams como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos


Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	ras.h
Biblioteca	Rasapi32.lib
DLL	Rasapi32.dll