SourceVu will show references to esp_mqtt5_client_set_user_property() from the following samples and libraries:
Symbols ![]()
loading...
Files ![]()
loading...
esp_mqtt5_client_set_user_property() function
Set MQTT5 client user property configuration This API will allocate memory for user_property, please DO NOT forget `call esp_mqtt5_client_delete_user_property` after you use it. Before publish data, subscribe topic, unsubscribe, etc, call this API to set user property if have
Syntax
esp_err_t esp_mqtt5_client_set_user_property(mqtt5_user_property_handle_t *user_property,
esp_mqtt5_user_property_item_t item[],
uint8_t item_num);
Implemented in ![]()
mqtt5_client.c:644
Return value
ESP_ERR_NO_MEM if failed to allocate ESP_FAIL on fail ESP_OK on success
Related Functions
Found 9 other functions taking a ![]()
mqtt5_user_property_list_t
argument:
Function
Description
Free the user property list This API will free the memory in user property list and free user_property itself
Get MQTT5 client user property This API can use with `esp_mqtt5_client_get_user_property_count` to get list count of user property. And malloc number of count item array memory to store the user property data. Please DO NOT forget the item memory, key and value point in item memory when get user property data successfully.
Get MQTT5 client user property list count
Examples
Code
Location
Call Tree
from 0/1 examplesesp_mqtt5_client_set_user_property() calls 5 functions:
Data Use
from 0/1 examplesesp_mqtt5_client_set_user_property() reads 11 variables and writes 2 variables:
Lifecycle
from 0/1 examplesesp_mqtt5_client_set_user_property() allocates 1 types and frees 2 typess: