diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2006-08-02 09:33:32 +0000 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2006-08-02 09:33:32 +0000 |
| commit | fbcdc192d58ee0ffada26a7ea42feade87a81ecb (patch) | |
| tree | 1a69023bd34f9f48b844a73d45ef0ee2e42e834d | |
| parent | ee642859ef04b9588e654ded629224fb0756f017 (diff) | |
| download | curl-fbcdc192d58ee0ffada26a7ea42feade87a81ecb.tar.gz | |
a CURLOPT_PROGRESSFUNCTION clarification
| -rw-r--r-- | docs/libcurl/curl_easy_setopt.3 | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/libcurl/curl_easy_setopt.3 b/docs/libcurl/curl_easy_setopt.3 index 6ac538a7a..6be387d11 100644 --- a/docs/libcurl/curl_easy_setopt.3 +++ b/docs/libcurl/curl_easy_setopt.3 @@ -169,11 +169,12 @@ added in 7.12.3) .IP CURLOPT_PROGRESSFUNCTION 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 -its internal equivalent with a frequent interval during data transfer (roughly -once per second). Unknown/unused argument values pass to the callback will be -set to zero (like if you only download data, the upload size will remain -0). Returning a non-zero value from this callback will cause libcurl to abort -the transfer and return \fICURLE_ABORTED_BY_CALLBACK\fP. +its internal equivalent with a frequent interval during operation (roughly +once per second) no matter if data is being transfered or not. Unknown/unused +argument values passed to the callback will be set to zero (like if you only +download data, the upload size will remain 0). Returning a non-zero value from +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 called during periods of idleness unless you call the appropriate libcurl |