Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_XFERINFODATA.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
                      9: .\" *
                     10: .\" * This software is licensed as described in the file COPYING, which
                     11: .\" * you should have received as part of this distribution. The terms
                     12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
                     13: .\" *
                     14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
                     15: .\" * copies of the Software, and permit persons to whom the Software is
                     16: .\" * furnished to do so, under the terms of the COPYING file.
                     17: .\" *
                     18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
                     19: .\" * KIND, either express or implied.
                     20: .\" *
                     21: .\" **************************************************************************
                     22: .\"
                     23: .TH CURLOPT_XFERINFODATA 3 "October 09, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_XFERINFODATA \- custom pointer passed to the progress callback
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_XFERINFODATA, void *pointer);
                     31: .SH DESCRIPTION
                     32: Pass a \fIpointer\fP that will be untouched by libcurl and passed as the first
                     33: argument in the progress callback set with \fICURLOPT_XFERINFOFUNCTION(3)\fP.
                     34: 
                     35: This is an alias for \fICURLOPT_PROGRESSDATA(3)\fP.
                     36: .SH DEFAULT
                     37: The default value of this parameter is NULL.
                     38: .SH PROTOCOLS
                     39: All
                     40: .SH EXAMPLE
                     41: https://curl.haxx.se/libcurl/c/progressfunc.html
                     42: .SH AVAILABILITY
                     43: Added in 7.32.0
                     44: .SH RETURN VALUE
                     45: Returns CURLE_OK
                     46: .SH "SEE ALSO"
                     47: .BR CURLOPT_XFERINFOFUNCTION "(3), " CURLOPT_VERBOSE "(3), "

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>