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

Статья
08/25/2023

Функция RasSetEntryDialParams изменяет сведения о подключении, сохраненные при последнем успешном вызове функции RasDial или RasSetEntryDialParams для указанной записи телефонной книги.

Синтаксис

DWORD RasSetEntryDialParamsA(
  [in] LPCSTR           unnamedParam1,
  [in] LPRASDIALPARAMSA unnamedParam2,
  [in] BOOL             unnamedParam3
);

Параметры

[in] unnamedParam1

Указатель на строку, завершающуюся значением NULL, которая указывает полный путь и имя файла телефонной книги (PBK). Если этот параметр имеет значение NULL, функция использует текущий файл телефонной книги по умолчанию. Файл телефонной книги по умолчанию — это файл, выбранный пользователем на странице свойств Пользовательские настройки диалогового окна Сеть удаленного доступа.

Windows Me/98/95: Этот параметр всегда должен иметь значение NULL. Коммутируемая сеть сохраняет записи телефонной книги в реестре, а не в файле телефонной книги.

[in] unnamedParam2

Указатель на структуру RASDIALPARAMS , которая указывает параметры подключения, связанные с записью телефонной книги. RasSetEntryDialParams использует элементы структуры следующим образом.

Член	Значение
dwSize	Для определения версии структуры необходимо указать размер (RASDIALPARAMS).
szEntryName	Строка, завершающаяся нулевым значением, идентифицирующая запись телефонной книги, для которую необходимо задать параметры.
szPhoneNumber	Не используется. Задайте значение NULL.
szCallbackNumber	Строка, завершающаяся значением NULL, содержащая номер телефона обратного вызова. Если szCallbackNumber является пустой строкой ( "" ), номер обратного вызова не изменяется.
szUserName	Строка, завершающаяся нулевым значением, которая содержит имя пользователя, связанного с этой записью. Если szUserName является пустой строкой, имя пользователя не изменяется.
szPassword	Строка, завершающаяся нулевым значением, которая содержит пароль пользователя, указанного в szUserName. Если szUserName является пустой строкой, пароль не изменяется. Если szPassword является пустой строкой, а fRemovePassword имеет значение FALSE, пароль устанавливается в пустую строку. Если параметр fRemovePassword имеет значение TRUE, пароль, хранящийся в этой записи телефонной книги для пользователя, указанного szUserName , удаляется независимо от содержимого строки szPassword . Windows NT 4.0: пароль изменяется на строку, указанную szPassword, независимо от того, является ли szUserName пустой строкой. Windows XP/2000: Если szPassword содержит дескриптор пароля, возвращенный RasGetCredentials или RasGetEntryDialParams, RasSetEntryDialParams возвращается успешно, не изменяя сохраненный в данный момент пароль.
szDomain	Строка, завершающаяся нулевым значением, содержащая имя домена, в котором выполняется вход. Если szDomain является пустой строкой, доменное имя не изменяется.
dwSubEntry	Указывает (на основе одного) индекса начального вложенного объекта, набираемого при установлении соединения.
dwCallbackId	Указывает определяемое приложением значение, которое RAS передает функции обратного вызова RasDialFunc2 .

[in] unnamedParam3

Указывает, следует ли удалить сохраненный пароль записи телефонной книги для пользователя, указанного в lprasdialparams-szUserName>. Если параметр fRemovePassword имеет значение TRUE, пароль удаляется. Установка для параметра fRemovePassword значения TRUE эквивалентна проверке флажка "Unsave Password" проверка в сети удаленного доступа. При установке пароля или других свойств записи телефонной книги задайте для параметра fRemovePassword значение FALSE.

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

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

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

Значение	Описание
ERROR_BUFFER_INVALID	Недопустимый адрес или буфер, указанный в lprasdialparams .
ERROR_CANNOT_OPEN_PHONEBOOK	Телефонная книга повреждена или отсутствуют компоненты.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	Запись телефонной книги не существует.

Windows XP или более поздней версии: Не используйте функцию RasSetEntryDialParams . Чтобы задать учетные данные для записи телефонной книги, используйте функцию RasSetCredentials . Задайте члены RASDIALPARAMS без учетных данных (например , szCallbackNumber, dwSubEntry или dwCallbackId) непосредственно в структуре RASDIALPARAMS , переданной в качестве параметра функции RasDial .

Примечание

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

Требования

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