Skip to content

Commit

Permalink
esp_http_server : Minor clarification in httpd_req_get_url_query_str(…
Browse files Browse the repository at this point in the history
…) API documentation

Closes espressif#3374
  • Loading branch information
anurag-kar authored and trombik committed Aug 9, 2019
1 parent d636aab commit 18e2107
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion components/esp_http_server/include/esp_http_server.h
Original file line number Diff line number Diff line change
Expand Up @@ -872,7 +872,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)
Expand Down

0 comments on commit 18e2107

Please sign in to comment.