mirror of
https://codeberg.org/kiss-community/repo
synced 2024-08-19 12:46:58 +00:00
60 lines
1.4 KiB
Groff
60 lines
1.4 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_XFERINFODATA.md
|
|
.TH CURLOPT_XFERINFODATA 3 "2024-06-01" libcurl
|
|
.SH NAME
|
|
CURLOPT_XFERINFODATA \- pointer passed to the progress callback
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_XFERINFODATA, void *pointer);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a \fIpointer\fP that is untouched by libcurl and passed as the first
|
|
argument in the progress callback set with \fICURLOPT_XFERINFOFUNCTION(3)\fP.
|
|
|
|
This is an alias for \fICURLOPT_PROGRESSDATA(3)\fP.
|
|
.SH DEFAULT
|
|
The default value of this parameter is NULL.
|
|
.SH PROTOCOLS
|
|
All
|
|
.SH EXAMPLE
|
|
.nf
|
|
struct progress {
|
|
char *private;
|
|
size_t size;
|
|
};
|
|
|
|
static size_t progress_cb(void *clientp,
|
|
curl_off_t dltotal,
|
|
curl_off_t dlnow,
|
|
curl_off_t ultotal,
|
|
curl_off_t ulnow)
|
|
{
|
|
struct progress *memory = clientp;
|
|
printf("private ptr: %p\\n", memory->private);
|
|
/* use the values */
|
|
|
|
return 0; /* all is good */
|
|
}
|
|
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
struct progress data;
|
|
|
|
/* pass struct to callback */
|
|
curl_easy_setopt(curl, CURLOPT_XFERINFODATA, &data);
|
|
curl_easy_setopt(curl, CURLOPT_XFERINFOFUNCTION, progress_cb);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.32.0
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK
|
|
.SH SEE ALSO
|
|
.BR CURLOPT_NOPROGRESS (3),
|
|
.BR CURLOPT_VERBOSE (3),
|
|
.BR CURLOPT_XFERINFOFUNCTION (3)
|