Compartilhar via


Função RasSetAutodialAddressA (ras.h)

A função RasSetAutodialAddress pode adicionar um endereço ao banco de dados de mapeamento do AutoDial. Como alternativa, a função pode excluir ou modificar os dados associados a um endereço existente no banco de dados.

Sintaxe

DWORD RasSetAutodialAddressA(
  [in] LPCSTR              unnamedParam1,
  [in] DWORD               unnamedParam2,
  [in] LPRASAUTODIALENTRYA unnamedParam3,
  [in] DWORD               unnamedParam4,
  [in] DWORD               unnamedParam5
);

Parâmetros

[in] unnamedParam1

Ponteiro para um cadeia de caracteresterminada nula que especifica o endereço a ser adicionado, excluído ou modificado. Esse endereço pode ser um endereço IP, um nome de host da Internet ("www.microsoft.com"), ou um nome NetBIOS ("products1").

Se esse parâmetro for NULL, a função definirá a conexão de Internet padrão (consulte Comentários). Se esse parâmetro apontar para uma cadeia de caracteres de comprimento zero, a função excluirá a conexão de Internet padrão.

[in] unnamedParam2

Reservado; deve ser zero.

[in] unnamedParam3

Ponteiro para uma matriz de uma ou mais estruturas RASAUTODIALENTRY a serem associadas ao endereço lpszAddress. Se lpAutoDialEntries for NULL e dwcbAutoDialEntries for zero, RasSetAutodialAddress excluirá todas as estruturas associadas a lpszAddress do banco de dados de mapeamento.

[in] unnamedParam4

Especifica o tamanho, em bytes, do buffer lpAutoDialEntries.

[in] unnamedParam5

Especifica o número de estruturas de RASAUTODIALENTRY no buffer lpAutoDialEntries.

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
ERROR_INVALID_SIZE
O dwSize membro da estrutura de RASAUTODIALENTRY é um valor inválido.
ERROR_INVALID_PARAMETER
O parâmetro lpszAddress é NULL.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY
O nome da conexão especificado em lpAutoDialEntries não existe.

Observações

Um endereço no banco de dados de mapeamento do AutoDial pode ter qualquer número de entradas de RASAUTODIALENTRY associadas. Cada entrada especifica informações do AutoDial para um local de discagem TAPI específico.

Se o endereço especificado pelo parâmetro lpszAddress for um endereço existente no banco de dados e o parâmetro lpAutoDialEntries não for NULL, a função RasSetAutodialAddress modificará o conjunto de entradas do AutoDial associadas ao endereço. Se uma entrada no lpAutoDialEntries matriz especificar um local de discagem para o qual o endereço já tem uma entrada, a função substituirá a entrada existente pela nova entrada. Caso contrário, a função simplesmente adiciona as entradas lpAutoDialEntries ao conjunto de entradas do endereço.

Se o endereço lpszAddress existir no banco de dados, lpAutoDialEntries será NULL e lpAutoDialEntries for zero, RasSetAutodialAddress excluirá o endereço do banco de dados.

Se o endereço lpszAddress não existir no banco de dados, RasSetAutodialAddress adicionará o endereço ao banco de dados. O parâmetro lpAutoDialEntries especifica as entradas do AutoDial a serem associadas ao novo endereço.

O RAS dá suporte a uma conexão de Internet padrão global para o computador local e dá suporte a uma conexão de Internet padrão para cada usuário.

Quando o parâmetro lpszAddress é NULL e o parâmetro lpAutoDialEntries especifica um nome de conexão com uma entrada, RasSetAutodialAddress define a conexão como a conexão de Internet padrão. O nome da conexão especificado em lpAutoDialEntries já deve existir. Se isso não acontecer, ERROR_CANNOT_FIND_PHONEBOOK_ENTRY será retornado.

Quando o parâmetro lpszAddress é uma cadeia de caracteres de comprimento zero e o parâmetro lpAutoDialEntries especifica um nome de conexão vazio com uma entrada, RasSetAutodialAddress exclui a conexão de Internet padrão.

Em computadores cliente que não são de domínio, se um usuário quiser definir uma conexão como a conexão de Internet padrão e especificar uma conexão "para todos os usuários" no szEntry membro da estrutura de RASAUTODIALENTRY, a conexão de Internet padrão será definida globalmente no computador local. Em todos os outros casos, a conexão de Internet padrão é definida para cada usuário do computador individualmente.

É possível ter duas conexões que tenham o mesmo nome se uma estiver configurada como uma conexão "para todos os usuários" e a outra estiver configurada como uma conexão "somente para mim". Se o parâmetro lpAutoDialEntries especificar um nome de conexão que corresponda a uma conexão global e por usuário, a conexão por usuário será definida.

Nota

O cabeçalho ras.h define RasSetAutodialAddress 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

RASAUTODIALENTRY

RasEnumAutodialAddresses

RasGetAutodialAddress

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

Funções do Serviço de Acesso Remoto