CURLOPT_WRITEFUNCTION.3: clarify what libcurl returns for CURL_WRITEFUNC_ERROR

It returns CURLE_WRITE_ERROR. It was not previously stated clearly.

Reported-by: enWILLYado on github
Fixes #12201
Closes #12203
This commit is contained in:
Daniel Stenberg 2023-10-26 14:03:47 +02:00
parent 6ec70a9dd3
commit 910f740ce2
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2

View File

@ -63,7 +63,8 @@ that amount differs from the amount passed to your callback function, it
signals an error condition to the library. This causes the transfer to get
aborted and the libcurl function used returns \fICURLE_WRITE_ERROR\fP.
You can also abort the transfer by returning CURL_WRITEFUNC_ERROR. (7.87.0)
You can also abort the transfer by returning CURL_WRITEFUNC_ERROR (added in
7.87.0), which makes \fICURLE_WRITE_ERROR\fP get returned.
If the callback function returns CURL_WRITEFUNC_PAUSE it pauses this
transfer. See \fIcurl_easy_pause(3)\fP for further details.