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

Статья
03/01/2024

Используйте функцию RasGetCustomAuthData для получения сведений о проверке подлинности для конкретного подключения. Эти сведения не относятся к конкретному пользователю.

Синтаксис

DWORD RasGetCustomAuthDataA(
  [in]      LPCSTR pszPhonebook,
  [in]      LPCSTR pszEntry,
  [out]     BYTE   *pbCustomAuthData,
  [in, out] DWORD  *pdwSizeofCustomAuthData
);

Параметры

[in] pszPhonebook

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

[in] pszEntry

Указатель на строку, завершающуюся значением NULL, которая указывает существующее имя записи.

[out] pbCustomAuthData

Указатель на буфер, который получает данные проверки подлинности. Вызывающий объект должен выделить память для этого буфера. Если буфер недостаточно велик, RasGetCustomAuthData возвращает ERROR_BUFFER_TOO_SMALL, а параметр pdwSizeofEapData содержит необходимый размер.

[in, out] pdwSizeofCustomAuthData

Указатель на переменную DWORD , которая во входных данных указывает размер буфера, на который указывает параметр pbCustomAuthData .

Если буфер, заданный параметром pbCustomAuthData , недостаточно велик, то pdwSizeofEapData получает на выходных данных требуемый размер.

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

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

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

Значение	Значение
E_INVALIDARG	Параметр pdwSizeofCustomAuthData имеет значение NULL.
ERROR_BUFFER_TOO_SMALL	Буфер, на который указывает pbCustomAuthData , слишком мал для получения данных. PdwSizeofCustomAuthData содержит требуемый размер.
ERROR_CANNOT_OPEN_PHONEBOOK	RasGetEapUserData не удалось открыть указанный файл телефонной книги.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	RasGetEapUserData не удалось найти указанную запись в телефонной книге.
Другое	Используйте FormatMessage , чтобы получить системное сообщение об ошибке, соответствующее возвращаемому коду ошибки.

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

Требования

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

См. также раздел

RasGetEapUserData

RasSetCustomAuthData

Share via