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

Статья
11/20/2024

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

Синтаксис

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

Параметры

[in] pszPhonebook

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

[in] pszEntry

Указатель на строку null-terminated, указывающую существующее имя записи.

[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 или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

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

См. также

RasGetEapUserData

RasSetCustomAuthData

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