Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Functions with 'void' parameter list return "ESP_ERR_INVALID_ARG" (documentation) (IDFGH-11163) #12331

Closed
3 tasks done
nkaaf opened this issue Sep 29, 2023 · 2 comments
Closed
3 tasks done
Assignees
Labels
Resolution: NA Issue resolution is unavailable Status: Done Issue is done internally

Comments

@nkaaf
Copy link
Contributor

nkaaf commented Sep 29, 2023

Answers checklist.

  • I have read the documentation ESP-IDF Programming Guide and the issue is not addressed there.
  • I have updated my IDF branch (master or release) to the latest version and checked that the issue is present there.
  • I have searched the issue tracker for a similar issue and not found a similar issue.

General issue report

I wonder if there is a reason why functions without parameters (void) can return "ESP_ERR_INVALID_ARG" according to the documentation. I found two such functions in "esp_wifi.h", I don't know if there are more functions in the project:

  • esp_wifi_start
  • esp_wifi_clear_ap_list

If this is because underlaying functions can return the ESP_ERR_INVALID_ARG error, I could understand, but I find it very confusing because the "main" API functions that users call do not take parameters.

@espressif-bot espressif-bot added the Status: Opened Issue is new label Sep 29, 2023
@github-actions github-actions bot changed the title Functions with 'void' parameter list return "ESP_ERR_INVALID_ARG" (documentation) Functions with 'void' parameter list return "ESP_ERR_INVALID_ARG" (documentation) (IDFGH-11163) Sep 29, 2023
@hansw123
Copy link
Collaborator

hi @nkaaf
sorry for late reply
It is indeed because the function called inside the api returns ESP_ERR_INVALID_ARG, and we'll discuss whether to change the internal handling or change the description of the api to make it more accurate

@espressif-bot espressif-bot added Status: In Progress Work is in progress and removed Status: Opened Issue is new labels Apr 24, 2024
@espressif-bot espressif-bot added Status: Reviewing Issue is being reviewed and removed Status: In Progress Work is in progress labels May 8, 2024
@espressif-bot espressif-bot added Status: Done Issue is done internally Resolution: NA Issue resolution is unavailable and removed Status: Reviewing Issue is being reviewed labels May 21, 2024
@Indastri
Copy link
Collaborator

Indastri commented Jul 1, 2024

Closing the issue as completed. If you encounter more problems feel free to reopen this one or create a new issue.

Cheers!

@Indastri Indastri closed this as completed Jul 1, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Resolution: NA Issue resolution is unavailable Status: Done Issue is done internally
Projects
None yet
Development

No branches or pull requests

4 participants