alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs(esp-event): Update description of esp_event_handler_instance_x

Browse Source 
Add a note to esp_event_handler_instance_register_with and
esp_event_handler_instance_register to specify that calling those
functions with the instance parameter set to NULL is equivalent to
calling esp_event_handler_register_with and esp_event_handler_register.

Closes https://github.com/espressif/esp-idf/issues/12818
This commit is contained in:
Guillaume Souchere 2023-12-21 13:32:47 +01:00
parent 7f64b4203b
commit 8f407949c6
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
components/esp_event/include/esp_event.h
View File

@ -199,6 +199,8 @@ esp_err_t esp_event_handler_register_with(esp_event_loop_handle_t event_loop,
* @note the event loop library does not maintain a copy of event_handler_arg, therefore the user should * @note the event loop library does not maintain a copy of event_handler_arg, therefore the user should
* ensure that event_handler_arg still points to a valid location by the time the handler gets called * ensure that event_handler_arg still points to a valid location by the time the handler gets called
* *
* @note Calling this function with instance set to NULL is equivalent to calling esp_event_handler_register_with.
*
* @return * @return
* - ESP_OK: Success * - ESP_OK: Success
* - ESP_ERR_NO_MEM: Cannot allocate memory for the handler * - ESP_ERR_NO_MEM: Cannot allocate memory for the handler
@ -232,6 +234,8 @@ esp_err_t esp_event_handler_instance_register_with(esp_event_loop_handle_t event
* @note the event loop library does not maintain a copy of event_handler_arg, therefore the user should * @note the event loop library does not maintain a copy of event_handler_arg, therefore the user should
* ensure that event_handler_arg still points to a valid location by the time the handler gets called * ensure that event_handler_arg still points to a valid location by the time the handler gets called
* *
* @note Calling this function with instance set to NULL is equivalent to calling esp_event_handler_register.
*
* @return * @return
* - ESP_OK: Success * - ESP_OK: Success
* - ESP_ERR_NO_MEM: Cannot allocate memory for the handler * - ESP_ERR_NO_MEM: Cannot allocate memory for the handler