SourceVu will show references to esp_local_ctrl_prop from the following samples and libraries:
Symbols ![]()
loading...
Files ![]()
loading...
esp_local_ctrl_prop struct
Property description data structure, which is to be populated and passed to the `esp_local_ctrl_add_property()` function Once a property is added, its structure is available for read-only access inside `get_prop_values()` and `set_prop_values()` handlers.
Syntax
typedef struct esp_local_ctrl_prop
{
char *name;
uint32_t type;
size_t size;
uint32_t flags;
void *ctx;
void (*ctx_free_fn)(void *ctx);
} esp_local_ctrl_prop_t;
Fields
Field
Declared as
Description
size_t
Size of the property value, which: - if zero, the property can have values of variable size - if non-zero, the property can have values of fixed size only, therefore, checks are performed internally by esp_local_ctrl when setting the value of such a property.
uint32_t
Flags set for this property. This could be a bit field. A flag may indicate property behavior, e.g. read-only / constant.
void *
Pointer to some context data relevant for this property. This will be available for use inside the `get_prop_values` and `set_prop_values` handlers as a part of this property structure. When set, this is valid throughout the lifetime of a property, till either the property is removed or the esp_local_ctrl service is stopped.
void (*)(void *ctx)
Function used by esp_local_ctrl to internally free the property context when `esp_local_ctrl_remove_property()` or `esp_local_ctrl_stop()` is called.
Related Functions
Found 2 other functions taking a esp_local_ctrl_prop
argument:
Function
Description
Add a new property This adds a new property and allocates internal resources for it. The total number of properties that could be added is limited by configuration option `max_properties`
Get descriptions and values of multiple properties at the same time. The properties are requested by indices. This internally calls the `get_prop_values` handler specified in the `esp_local_ctrl_handlers_t` structure. Since `get_prop_values` accepts property structure, the indices are first converted to the corresponding `esp_local_ctrl_prop_t` internally.