Функция RasSetAutodialAddressA (ras.h)

Статья
08/25/2023

Функция RasSetAutodialAddress может добавить адрес в базу данных сопоставления AutoDial. Кроме того, функция может удалять или изменять данные, связанные с существующим адресом в базе данных.

Синтаксис

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

Параметры

[in] unnamedParam1

Указатель на строку, завершающуюся значением NULL, которая указывает адрес для добавления, удаления или изменения. Это может быть IP-адрес, имя узла Интернета ("www.microsoft.com") или netBIOS-имя ("products1").

Если этот параметр имеет значение NULL, функция устанавливает подключение к Интернету по умолчанию (см. примечания). Если этот параметр указывает на строку нулевой длины, функция удаляет подключение к Интернету по умолчанию.

[in] unnamedParam2

Защищены; значение должно быть равно нулю.

[in] unnamedParam3

Указатель на массив из одной или нескольких структур RASAUTODIALENTRY , связанных с адресом lpszAddress . Если lpAutoDialEntries имеет значение NULL , а dwcbAutoDialEntries равно нулю, RasSetAutodialAddress удаляет все структуры, связанные с lpszAddress , из базы данных сопоставления.

[in] unnamedParam4

Задает размер буфера lpAutoDialEntries в байтах .

[in] unnamedParam5

Указывает количество структур RASAUTODIALENTRY в буфере lpAutoDialEntries .

Возвращаемое значение

Если функция завершается успешно, возвращаемое значение будет ERROR_SUCCESS.

Если функция завершается ошибкой, возвращается один из следующих кодов ошибок или значение из кода ошибок маршрутизации и удаленного доступа или Winerror.h.

Значение	Значение
ERROR_INVALID_SIZE	Элемент dwSize структуры RASAUTODIALENTRY является недопустимым значением.
ERROR_INVALID_PARAMETER	Параметр lpszAddress имеет значение NULL.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	Имя подключения, указанное в lpAutoDialEntries , не существует.

Адрес в базе данных автоматического сопоставления может содержать любое количество связанных записей RASAUTODIALENTRY . В каждой записи указываются сведения об автоподборе для определенного расположения набора TAPI.

Если адрес, указанный параметром lpszAddress , является существующим адресом в базе данных, а параметр lpAutoDialEntries не равен NULL, функция RasSetAutodialAddress изменяет набор записей AutoDial, связанных с адресом. Если запись в массиве lpAutoDialEntries указывает расположение набора номера, для которого адрес уже содержит запись, функция заменяет существующую запись новой записью. В противном случае функция просто добавляет записи lpAutoDialEntries в набор записей для адреса.

Если адрес lpszAddress существует в базе данных, lpAutoDialEntries имеет значение NULL, а lpAutoDialEntries — ноль, RasSetAutodialAddress удаляет адрес из базы данных.

Если адрес lpszAddress не существует в базе данных, RasSetAutodialAddress добавляет его в базу данных. Параметр lpAutoDialEntries указывает записи AutoDial, которые необходимо связать с новым адресом.

RAS поддерживает подключение к Интернету по умолчанию, которое является глобальным для локального компьютера, и поддерживает подключение к Интернету по умолчанию для каждого пользователя.

Если параметр lpszAddress имеет значение NULL, а параметр lpAutoDialEntries указывает имя подключения с одной записью, RasSetAutodialAddress устанавливает подключение в качестве подключения к Интернету по умолчанию. Имя подключения, указанное в lpAutoDialEntries , уже должно существовать. Если это не так, возвращается ERROR_CANNOT_FIND_PHONEBOOK_ENTRY .

Если параметр lpszAddress является строкой нулевой длины, а параметр lpAutoDialEntries указывает пустое имя подключения с одной записью, RasSetAutodialAddress удаляет подключение к Интернету по умолчанию.

На клиентских компьютерах, не относящихся к домену, если пользователь хочет установить подключение к Интернету по умолчанию и указать подключение "для всех пользователей" в члене szEntry структуры RASAUTODIALENTRY , подключение к Интернету по умолчанию устанавливается глобально на локальном компьютере. Во всех остальных случаях подключение к Интернету по умолчанию устанавливается для каждого пользователя компьютера отдельно.

Можно иметь два подключения с одинаковыми именами, если одно настроено как подключение "для всех пользователей", а другое — как подключение "только для меня". Если параметр lpAutoDialEntries указывает имя подключения, соответствующее как глобальному, так и пользовательскому подключению, устанавливается подключение для каждого пользователя.

Примечание

Заголовок ras.h определяет RasSetAutodialAddress в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	ras.h
Библиотека	Rasapi32.lib
DLL	Rasapi32.dll