aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLOPT_HEADERFUNCTION.3
AgeCommit message (Collapse)Author
2019-12-26CURLOPT_HEADERFUNCTION.3: Document that size is always 1Jay Satiro
For compatibility with `fwrite`, the `CURLOPT_HEADERFUNCTION` callback is passed two `size_t` parameters which, when multiplied, designate the number of bytes of data passed in. In practice, CURL always sets the first parameter (`size`) to 1. This practice is also enshrined in documentation and cannot be changed in future. The documentation states that the default callback is `fwrite`, which means `fwrite` must be a suitable function for this purpose. However, the documentation also states that the callback must return the number of *bytes* it successfully handled, whereas ISO C `fwrite` returns the number of items (each of size `size`) which it wrote. The only way these numbers can be equal is if `size` is 1. Since `size` is 1 and can never be changed in future anyway, document that fact explicitly and let users rely on it. Reported-by: Frank Gevaerts Commit-message-by: Christopher Head Ref: https://github.com/curl/curl/pull/2787 Fixes https://github.com/curl/curl/issues/4758
2019-11-02copyrights: update all copyright notices to 2019 on files changed this yearVilhelm Prytz
Closes #4547
2019-08-28CURLOPT_HEADERFUNCTION.3: clarifyChristopher Head
Closes #4273
2018-11-22CURLOPT_HEADERFUNCTION.3: match 'nitems' name in synopsis and descriptionUnknownShadow200
Closes #3295
2018-08-11docs: Improve the manual pages of some callbacksMichael Kaufmann
- CURLOPT_HEADERFUNCTION: add newlines - CURLOPT_INTERLEAVEFUNCTION: fix the description of 'userdata' - CURLOPT_READDATA: mention crashes, same as in CURLOPT_WRITEDATA - CURLOPT_READFUNCTION: rename 'instream' to 'userdata' and explain how to set it Closes https://github.com/curl/curl/pull/2868
2018-04-17docs: fix typosJakub Wilk
Closes https://github.com/curl/curl/pull/2503
2018-02-16CURLOPT_HEADERFUNCTION.3: fix typo from d939226813Daniel Stenberg
Reported-by: Erik Johansson Bug: https://github.com/curl/curl/commit/d9392268131c1b8d18dec3fa30e0bded833a5db7#commitcomment-27607495
2018-02-16CURLOPT_HEADERFUNCTION.3: mention folded headersDaniel Stenberg
2016-02-03URLs: change all http:// URLs to https://Daniel Stenberg
2015-11-23CURLOPT_HEADERFUNCTION.3: fix typoDaniel Stenberg
Refer to _HEADERDATA not _WRITEDATA. Reported-by: MichaƂ Piechowski
2015-04-20CURLOPT_HEADERFUNCTION.3: match parameter name in synopsis and descDaniel Stenberg
Bug: https://github.com/bagder/curl/issues/229 Reported-by: bsammon
2015-03-17CURLOPT_*.3: more examples and editsDaniel Stenberg
2015-03-02CURLOPT_HEADERFUNCTION.3: typo in error code nameDaniel Stenberg
Reported-by: Jonathan Cardoso
2014-06-17opts: 3 more options as man pagesDaniel Stenberg