comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLOPT_HEADERDATA.3 @ 2:b50eed0cc0ef upstream

ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
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_HEADERDATA 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_HEADERDATA \- pointer to pass to header callback
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HEADERDATA, void *pointer);
30 .SH DESCRIPTION
31 Pass a \fIpointer\fP to be used to write the header part of the received data
32 to.
33
34 If \fICURLOPT_WRITEFUNCTION(3)\fP or \fICURLOPT_HEADERFUNCTION(3)\fP is used,
35 \fIpointer\fP will be passed in to the respective callback.
36
37 If neither of those options are set, \fIpointer\fP must be a valid FILE * and
38 it will be used by a plain fwrite() to write headers to.
39 .SH DEFAULT
40 NULL
41 .SH PROTOCOLS
42 All
43 .SH EXAMPLE
44 .nf
45 struct my_info {
46 int shoesize;
47 char *secret;
48 };
49
50 static size_t header_callback(char *buffer, size_t size,
51 size_t nitems, void *userdata)
52 {
53 struct my_info *i = (struct my_info *)userdata;
54
55 /* now this callback can access the my_info struct */
56
57 return nitems * size;
58 }
59
60 CURL *curl = curl_easy_init();
61 if(curl) {
62 struct my_info my = { 10, "the cookies are in the cupboard" };
63 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
64
65 curl_easy_setopt(curl, CURLOPT_HEADERFUNCTION, header_callback);
66
67 /* pass in custom data to the callback */
68 curl_easy_setopt(curl, CURLOPT_HEADERDATA, &my);
69
70 curl_easy_perform(curl);
71 }
72 .fi
73 .SH AVAILABILITY
74 Always
75 .SH RETURN VALUE
76 Returns CURLE_OK
77 .SH "SEE ALSO"
78 .BR CURLOPT_HEADERFUNCTION "(3), " CURLOPT_WRITEFUNCTION "(3), "