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

Статья
11/20/2024

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

Синтаксис

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

Параметры

[in] unnamedParam1

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

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

[in] unnamedParam2

Скрытный; должно быть равно нулю.

[in] unnamedParam3

Указатель на массив одного или нескольких структур RASAUTODIALENTRY, связанных с адресом lpszAddres s. Если lpAutoDialEntriesnull и dwcbAutoDialEntries равно нулю, RasSetAutodialAddress удаляет все структуры, связанные с lpszAddress из базы данных сопоставления.

[in] unnamedParam4

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

[in] unnamedParam5

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

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

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

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

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

Замечания

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

Если адрес, указанный параметром lpszAddress является существующим адресом в базе данных, а параметр lpAutoDialEntries не является NULL, функция RasSetAutodialAddress изменяет набор записей автодиализации, связанных с адресом. Если запись в массиве 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 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	ras.h
библиотеки	Rasapi32.lib
DLL	Rasapi32.dll

См. также

RASAUTODIALENTRY

RasEnumAutodialAddresses

RasGetAutodialAddress

Обзор службы удаленного доступа (RAS)

функции службы удаленного доступа

Поделиться через