Функция WlanSetProfileEapXmlUserData (wlanapi.h)

Статья
08/28/2023

Функция WlanSetProfileEapXmlUserData задает учетные данные пользователя EAP в соответствии с XML-строкой. Учетные данные пользователя применяются к профилю на адаптере. Эти учетные данные могут использоваться только вызывающим.

Синтаксис

DWORD WlanSetProfileEapXmlUserData(
  [in] HANDLE     hClientHandle,
  [in] const GUID *pInterfaceGuid,
  [in] LPCWSTR    strProfileName,
  [in] DWORD      dwFlags,
  [in] LPCWSTR    strEapXmlUserData,
       PVOID      pReserved
);

Параметры

[in] hClientHandle

Дескриптор сеанса клиента, полученный при предыдущем вызове функции WlanOpenHandle .

[in] pInterfaceGuid

GUID интерфейса.

[in] strProfileName

Имя профиля, связанного с данными пользователя EAP. В именах профилей учитывается регистр. Эта строка должна быть завершена null.

Windows XP с пакетом обновления 3 (SP3) и API беспроводной локальной сети для Windows XP с пакетом обновления 2 (SP2): Указанное имя должно совпадать с именем профиля, автоматически полученным из SSID сети. Для сетевого профиля инфраструктуры необходимо указать SSID для имени профиля. Для нерегламентированного сетевого профиля указанное имя должно быть SSID нерегламентированной сети, за которым следует -adhoc.

[in] dwFlags

Набор флагов, которые изменяют поведение функции.

В API беспроводной локальной сети для Windows XP с пакетом обновления 2 (SP2), Windows XP с пакетом обновления 3 (SP3), Windows Vista и Windows Server 2008 этот параметр зарезервирован и должен иметь нулевое значение.

В Windows 7, Windows Server 2008 R2 и более поздних версиях этот параметр может иметь одно из следующих значений.

Значение	Значение
WLAN_SET_EAPHOST_DATA_ALL_USERS 0x00000001	Задайте данные узла EAP для всех пользователей этого профиля.

[in] strEapXmlUserData

Указатель на XML-данные, используемые для задания учетных данных пользователя.

XML-данные должны основываться на схеме учетных данных пользователя EAPHost. Примеры XML-данных учетных данных пользователя см. в разделе Свойства пользователя EAPHost.

pReserved

Зарезервировано для последующего использования. Необходимо задать значение NULL.

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

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

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

Код возврата	Описание
ERROR_ACCESS_DENIED	Отказано в доступе". Это значение возвращается, если вызывающий объект не имеет доступа на запись в профиль.
ERROR_BAD_PROFILE	Профиль сетевого подключения поврежден. Эта ошибка возвращается, если не удалось проанализировать профиль, указанный в параметре strProfileName .
ERROR_INVALID_PARAMETER	Неправильный параметр. Это значение возвращается при возникновении какого-либо из следующих условий: hClientHandle имеет значение NULL. pInterfaceGuid имеет значение NULL. strProfileName имеет значение NULL. StrEapXmlUserData имеет значение NULL. pReserved не имеет значение NULL.
ERROR_INVALID_HANDLE	Недопустимый дескриптор. Эта ошибка возвращается, если дескриптор hClientHandle не найден в таблице дескрипторов.
ERROR_NOT_ENOUGH_MEMORY	Недостаточно места для обработки этой команды.
ERROR_NOT_SUPPORTED	Запрос не поддерживается. Это значение возвращается, если параметры профиля не разрешают хранение пользовательских данных. Это может произойти, если включен единый вход. В Windows 7, Windows Server 2008 R2 и более поздних версиях это значение возвращается, если функция WlanSetProfileEapXmlUserData была вызвана для профиля, использующего для проверки подлинности метод, отличный от 802.1X.
ERROR_SERVICE_NOT_ACTIVE	Служба не запущена. Это значение возвращается, если служба беспроводной локальной сети не запущена.
RPC_STATUS	Различные коды ошибок.

Функция WlanSetProfileEapXmlUserData задает учетные данные пользователя EAP для использования в профиле. Эту функцию можно вызывать только для профиля, использующего для проверки подлинности 802.1X. В Windows Vista и Windows Server 2008 эти учетные данные могут использоваться только вызывающим.

Параметр eapType — это структура EAP_METHOD_TYPE , содержащая сведения о типе, идентификации и авторе метода EAP. Элемент eapTypeструктуры EAP_METHOD_TYPE является EAP_TYPE структурой, содержащей сведения об идентификации типа и поставщика для метода EAP.

Дополнительные сведения о выделении типов методов EAP см. в разделе 6.2 документа RFC 3748 , опубликованного IETF.

В Windows 10 Windows Server 2016 и более поздних версий функция WlanSetProfileEapXmlUserData улучшена. Учетные данные пользователя EAP можно задать для всех пользователей профиля, если параметр dwFlags содержит WLAN_SET_EAPHOST_DATA_ALL_USERS.

Для всех функций беспроводной локальной сети требуется guid интерфейса для беспроводного интерфейса при выполнении операций с профилем. При удалении беспроводного интерфейса его состояние удаляется из службы беспроводной локальной сети (WLANSVC) и операции с профилем невозмещаются.

Функция WlanSetProfileEapXmlUserData может завершиться сбоем с ERROR_INVALID_PARAMETER , если беспроводной интерфейс, указанный в параметре pInterfaceGuid , был удален из системы (например, usb wireless adapter, который был удален).

WlanSetProfileEapXmlUserData может вызвать сбой беспроводного подключения при использовании EAP-TTLS, а API вызывается из 32-разрядного приложения, работающего в 64-разрядной операционной системе . Приложение должно быть создано для той же архитектуры ЦП, что и целевая ОС.

Windows XP с пакетом обновления 3 (SP3) и API беспроводной локальной сети для Windows XP с пакетом обновления 2 (SP2): Эту функцию можно использовать только для защищенных учетных данных EAP (PEAP). Его нельзя использовать для других типов EAP.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista, Windows XP с пакетом обновления 3 (SP3) [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Целевая платформа	Windows
Header	wlanapi.h (включая Wlanapi.h)
Библиотека	Wlanapi.lib
DLL	Wlanapi.dll
Распространяемые компоненты	API беспроводной локальной сети для Windows XP с пакетом обновления 2 (SP2)