curl / libcurl / API / curl_easy_setopt / CURLOPT_PROGRESSDATA

CURLOPT_PROGRESSDATA explained

Name

CURLOPT_PROGRESSDATA - pointer passed to the progress callback

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROGRESSDATA, void *pointer);

Description

Pass a pointer that will be untouched by libcurl and passed as the first argument in the progress callback set with CURLOPT_PROGRESSFUNCTION.

Default

The default value of this parameter is NULL.

Protocols

All

Example

 struct progress {
   char *private;
   size_t size;
 };
 
 static size_t progress_callback(void *clientp,
                                 double dltotal,
                                 double dlnow,
                                 double ultotal,
                                 double ulnow)
 {
   struct memory *progress = (struct progress *)clientp;
 
   /* use the values */
 
   return 0; /* all is good */
 }
 
 struct progress data;
 
 /* pass struct to callback  */
 curl_easy_setopt(curl_handle, CURLOPT_PROGRESSDATA, &data);
 
 curl_easy_setopt(curl_handle, CURLOPT_PROGRESSFUNCTION, progress_callback);

Availability

Always

Return value

Returns CURLE_OK