esp_wifi_set_vendor_ie() function

Set 802.11 Vendor-Specific Information Element

Syntax

Show:

Summary

Declaration

from esp_wifi.h:1090

esp_err_t esp_wifi_set_vendor_ie(bool enable, wifi_vendor_ie_type_t type, wifi_vendor_ie_id_t idx, const void *vnd_ie);

Arguments

Argument

Declared as

Description

enable

bool

If true, specified IE is enabled. If false, specified IE is removed.

type

wifi_vendor_ie_type_t

Information Element type. Determines the frame type to associate with the IE.

idx

wifi_vendor_ie_id_t

Index to set or clear. Each IE type can be associated with up to two elements (indices 0 & 1).

vnd_ie

const void *

Pointer to vendor specific element data. First 6 bytes should be a header with fields matching vendor_ie_data_t. If enable is false, this argument is ignored and can be NULL. Data does not need to remain valid after the function returns.

Return value

- ESP_OK: succeed - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by esp_wifi_init() - ESP_ERR_INVALID_ARG: Invalid argument, including if first byte of vnd_ie is not WIFI_VENDOR_IE_ELEMENT_ID (0xDD) or second byte is an invalid length. - ESP_ERR_NO_MEM: Out of memory

Examples

References

from examples

esp_wifi_set_vendor_ie() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle