Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

esp_http_server : Minor clarification in httpd_req_get_url_query_str() API documentation

Browse source 
Closes https://github.com/espressif/esp-idf/issues/3374
This commit is contained in:
Anurag Kar 2019-05-06 14:32:24 +05:30 committed by bot
parent 8e51f7e236
commit 92dc6a6dde
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
components/esp_http_server/include/esp_http_server.h
View file

@ -716,7 +716,10 @@ size_t httpd_req_get_url_query_len(httpd_req_t *r);
* a URI handler where httpd_req_t* request pointer is valid
* - If output size is greater than input, then the value is truncated,
* accompanied by truncation error as return value
* - Use httpd_req_get_url_query_len() to know the right buffer length
* - Prior to calling this function, one can use httpd_req_get_url_query_len()
* to know the query string length beforehand and hence allocate the buffer
* of right size (usually query string length + 1 for null termination)
* for storing the query string
*
* @param[in] r The request being responded to
* @param[out] buf Pointer to the buffer into which the query string will be copied (if found)