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

Статья
08/25/2023

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

Синтаксис

DWORD RasGetEntryDialParamsA(
  [in]      LPCSTR           unnamedParam1,
  [in, out] LPRASDIALPARAMSA unnamedParam2,
  [out]     LPBOOL           unnamedParam3
);

Параметры

[in] unnamedParam1

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

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

[in, out] unnamedParam2

Указатель на структуру RASDIALPARAMS .

Во входных данных элемент dwSize указывает размер структуры RASDIALPARAMS , а элемент szEntryName — допустимую запись телефонной книги.

В выходных данных структура получает параметры подключения, связанные с указанной записью телефонной книги.

Обратите внимание, что член структуры szPhoneNumber не получает номер телефона, связанный с записью телефонной книги. Чтобы получить номер телефона, связанный с записью телефонной книги, вызовите функцию RasGetEntryProperties . Если szPhoneNumber — пустая строка в структуре RASDIALPARAMS , переданная в RasDial, RasDial использует номер телефона, хранящийся в записи телефонной книги.

Элемент szPassword структуры RASDIALPARAMS не возвращает фактический пароль. Вместо этого szPassword содержит дескриптор сохраненного пароля. Замените этот дескриптор сохраненным паролем в последующих вызовах RasSetEntryDialParams и RasDial. При появлении этого дескриптора RasDial получает и использует сохраненный пароль. Значение этого дескриптора может измениться в будущих версиях операционной системы; не разрабатывать код, зависящий от содержимого или формата этого значения.

Windows NT и Windows Me/98/95: Функция безопасного пароля не поддерживается.

[out] unnamedParam3

Указатель на флаг, указывающий, извлекла ли функция пароль, связанный с именем пользователя для записи телефонной книги. Параметр lpfPassword имеет значение TRUE , если система сохранила пароль для указанной записи. Если в системе не сохранен пароль для этой записи, lpfPassword имеет значение FALSE.

Windows NT и Windows Me/98/95: Функция устанавливает для этого флага значение TRUE , если пароль пользователя был возвращен в элементе szPassword структуры RASDIALPARAMS , на которую указывает lprasdialparams.

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

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

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

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

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

Требования


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