| .\" ************************************************************************** |
| .\" * _ _ ____ _ |
| .\" * Project ___| | | | _ \| | |
| .\" * / __| | | | |_) | | |
| .\" * | (__| |_| | _ <| |___ |
| .\" * \___|\___/|_| \_\_____| |
| .\" * |
| .\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. |
| .\" * |
| .\" * This software is licensed as described in the file COPYING, which |
| .\" * you should have received as part of this distribution. The terms |
| .\" * are also available at https://curl.se/docs/copyright.html. |
| .\" * |
| .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| .\" * copies of the Software, and permit persons to whom the Software is |
| .\" * furnished to do so, under the terms of the COPYING file. |
| .\" * |
| .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| .\" * KIND, either express or implied. |
| .\" * |
| .\" * SPDX-License-Identifier: curl |
| .\" * |
| .\" ************************************************************************** |
| .\" |
| .TH CURLOPT_PROGRESSDATA 3 "17 Jun 2014" libcurl libcurl |
| .SH NAME |
| CURLOPT_PROGRESSDATA \- pointer passed to the progress callback |
| .SH SYNOPSIS |
| .nf |
| #include <curl/curl.h> |
| |
| CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROGRESSDATA, void *pointer); |
| .fi |
| .SH DESCRIPTION |
| Pass a \fIpointer\fP that will be untouched by libcurl and passed as the first |
| argument in the progress callback set with \fICURLOPT_PROGRESSFUNCTION(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_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); |
| .fi |
| .SH AVAILABILITY |
| Always |
| .SH RETURN VALUE |
| Returns CURLE_OK |
| .SH "SEE ALSO" |
| .BR CURLOPT_PROGRESSFUNCTION "(3), " CURLOPT_XFERINFOFUNCTION "(3), " |
