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

Статья
11/20/2024

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

Синтаксис

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

Параметры

[in] unnamedParam1

Указатель на строку null-terminated, указывающую полный путь и имя файла телефонной книги (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, если система сохранила пароль для указанной записи. Если в системе нет пароля, сохраненного для этой записи, lpfPasswordFALSE.

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