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

Статья
08/28/2023

Функция WlanSetProfileCustomUserData задает пользовательские данные, связанные с профилем.

Синтаксис

DWORD WlanSetProfileCustomUserData(
  [in] HANDLE      hClientHandle,
  [in] const GUID  *pInterfaceGuid,
  [in] LPCWSTR     strProfileName,
  [in] DWORD       dwDataSize,
  [in] const PBYTE pData,
       PVOID       pReserved
);

Параметры

[in] hClientHandle

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

[in] pInterfaceGuid

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

[in] strProfileName

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

[in] dwDataSize

Размер pData в байтах.

[in] pData

Указатель на пользовательские данные, которые необходимо задать.

pReserved

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

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

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

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

Код возврата	Описание
ERROR_INVALID_PARAMETER	Произошло одно из следующих условий: hClientHandle имеет значение NULL или недопустимо. pInterfaceGuid имеет значение NULL. strProfileName имеет значение NULL. pReserved не имеет значение NULL. dwDataSize не равно 0, а pData — NULL.
ERROR_INVALID_HANDLE	Дескриптор hClientHandle не найден в таблице дескрипторов.
ERROR_NOT_SUPPORTED	Эта функция была вызвана из неподдерживаемой платформы. Это значение будет возвращено, если эта функция была вызвана из клиента Windows XP с пакетом обновления 3 (SP3) или API беспроводной локальной сети для Windows XP с пакетом обновления 2 (SP2).
RPC_STATUS	Различные коды ошибок.

Для каждого профиля беспроводной беспроводной локальной сети, используемого собственной службой автонастройки Wi-Fi, Windows поддерживает концепцию пользовательских данных. Эти пользовательские данные изначально отсутствуют, но их можно задать, вызвав функцию WlanSetProfileCustomUserData . Пользовательские данные сбрасываются до пустых при изменении профиля путем вызова функции WlanSetProfile .

После настройки пользовательских данных доступ к этим данным можно получить с помощью функции WlanGetProfileCustomUserData .

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

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

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Целевая платформа	Windows
Header	wlanapi.h (включая Wlanapi.h)
Библиотека	Wlanapi.lib
DLL	Wlanapi.dll