diff options
author | Daniel Stenberg <daniel@haxx.se> | 2000-06-08 15:13:41 +0000 |
---|---|---|
committer | Daniel Stenberg <daniel@haxx.se> | 2000-06-08 15:13:41 +0000 |
commit | dbc12876abe80c8c728ca8ba9e364120d008bba4 (patch) | |
tree | 699dbfb9c9bad57e068a1ad5678fe3a72c0e84ab /docs | |
parent | aedfcaa168173ecedc1838b72a599e20d149b1cb (diff) |
Added progress callback info
Diffstat (limited to 'docs')
-rw-r--r-- | docs/curl_easy_setopt.3 | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/curl_easy_setopt.3 b/docs/curl_easy_setopt.3 index 9b1d46223..57537b739 100644 --- a/docs/curl_easy_setopt.3 +++ b/docs/curl_easy_setopt.3 @@ -26,6 +26,7 @@ is the return code from the .I "curl_easy_init" call. .SH OPTIONS +These options are in a bit of random order, but you'll figure it out! .TP 0.8i .B CURLOPT_FILE Data pointer to pass instead of FILE * to the file write function. Note that @@ -302,6 +303,23 @@ Pass a pointer to a zero terminated string as parameter. It will be used to report information after a successful request. This string may contain variables that will be substituted by their contents when output. Described elsewhere. +.TP +.B CURLOPT_PROGRESSFUNCTION +Function pointer that should match the +.BI curl_progress_callback +prototype found in +.I <curl/curl.h> +This function gets called by libcurl instead of its internal +equivalent. Unknown/unused argument values 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 +CURLE_ABORTED_BY_CALLBACK. +.TP +.B CURLOPT_PROGRESSDATA +Pass a pointer that will be untouched by libcurl and passed as the first +argument in the progress callback set with +.I CURLOPT_PROGRESSFUNCTION + . .PP .SH RETURN VALUE 0 means the option was set properly, non-zero means an error as |