CURLOPT_XFERINFODATA - Man Page

pointer passed to the progress callback

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_XFERINFODATA, 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_XFERINFOFUNCTION(3).

This is an alias for CURLOPT_PROGRESSDATA(3).

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,
                                 curl_off_t dltotal,
                                 curl_off_t dlnow,
                                 curl_off_t ultotal,
                                 curl_off_t ulnow)
 {
   struct memory *progress = (struct progress *)userp;

   /* use the values */

   return 0; /* all is good */
 }

 struct progress data;

 /* pass struct to callback  */
 curl_easy_setopt(curl_handle, CURLOPT_XFERINFODATA, &data);

 curl_easy_setopt(curl_handle, CURLOPT_XFERINFOFUNCTION, progress_callback);

Availability

Added in 7.32.0

Return Value

Returns CURLE_OK

See Also

CURLOPT_XFERINFOFUNCTION(3), CURLOPT_VERBOSE(3),

Referenced By

curl_easy_setopt(3), CURLOPT_XFERINFOFUNCTION(3).

November 26, 2021 libcurl 7.81.0 curl_easy_setopt options