generic-library/curl
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

a CURLOPT_PROGRESSFUNCTION clarification

Browse Source
This commit is contained in:
Daniel Stenberg 2006-08-02 09:33:32 +00:00
parent ee642859ef
commit fbcdc192d5
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/libcurl/curl_easy_setopt.3
View File

@ -169,11 +169,12 @@ added in 7.12.3)
.IP CURLOPT_PROGRESSFUNCTION .IP CURLOPT_PROGRESSFUNCTION
Function pointer that should match the \fIcurl_progress_callback\fP prototype Function pointer that should match the \fIcurl_progress_callback\fP prototype
found in \fI<curl/curl.h>\fP. This function gets called by libcurl instead of found in \fI<curl/curl.h>\fP. This function gets called by libcurl instead of
its internal equivalent with a frequent interval during data transfer (roughly its internal equivalent with a frequent interval during operation (roughly
once per second). Unknown/unused argument values pass to the callback will be once per second) no matter if data is being transfered or not. Unknown/unused
set to zero (like if you only download data, the upload size will remain argument values passed to the callback will be set to zero (like if you only
0). Returning a non-zero value from this callback will cause libcurl to abort download data, the upload size will remain 0). Returning a non-zero value from
the transfer and return \fICURLE_ABORTED_BY_CALLBACK\fP. this callback will cause libcurl to abort the transfer and return
\fICURLE_ABORTED_BY_CALLBACK\fP.
If you transfer data with the multi interface, this function will not be If you transfer data with the multi interface, this function will not be
called during periods of idleness unless you call the appropriate libcurl called during periods of idleness unless you call the appropriate libcurl