feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

Merge branch 'doc/update-esp-event-instance-register-descrition' into 'master'

Browse Source 
docs(esp-event): Update description of esp_event_handler_instance_x

Closes IDFGH-11711

See merge request espressif/esp-idf!28063
This commit is contained in:
Guillaume Souchere
2024-01-23 13:48:31 +08:00
parent e3d4b901f9 8f407949c6
commit 7bb236254e
1 changed files with 4 additions and 0 deletions
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