Compartilhar via


Função RasGetEntryDialParamsA (ras.h)

A função RasGetEntryDialParams recupera as informações de conexão salvas pela última chamada bem-sucedida para a função de 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 um cadeia de caracteres nulaterminada que especifica o caminho completo e o nome do arquivo de um arquivo PBK (phone-book). Se esse parâmetro for NULL, a função usará o arquivo de agendamento telefônico padrão atual. O arquivo de lista telefônica padrão é o 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 agendamento telefônico no registro, em vez de em um arquivo de agendamento telefônico.

[in, out] unnamedParam2

Ponteiro para uma estrutura de RASDIALPARAMS .

Na entrada, o membro dwSize especifica o tamanho da estrutura de RASDIALPARAMS e o membro do szEntryName especifica uma entrada de lista telefônica válida.

Na saída, a estrutura recebe os parâmetros de conexão associados à entrada da lista telefônica especificada.

Observe que o szPhoneNumber membro 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 lista telefônica, chame a função RasGetEntryProperties. Se szPhoneNumber for uma cadeia de caracteres vazia na estrutura de RASDIALPARAMS passada para rasDial, RasDial usará o número de telefone armazenado na entrada da lista telefônica.

O szPassword membro da estrutura de 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 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á verdadeiro 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 verdadeiro se a senha do usuário foi retornada no membro do szPassword da estrutura RASDIALPARAMS apontada por lprasdialparams.

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 Descrição
ERROR_BUFFER_INVALID
O ponteiro lprasdialparams ou lpfPassword é inválido ou o lprasdialparams buffer é 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.

Observações

Nota

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 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

RASDIALPARAMS

RasCreatePhonebookEntry

RasDial

RasEditPhonebookEntry

RasSetEntryDialParams

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

Funções do Serviço de Acesso Remoto