comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLOPT_IOCTLDATA.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_IOCTLDATA 3 "16 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_IOCTLDATA \- custom pointer passed to I/O callback
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_IOCTLDATA, void *pointer);
30 .SH DESCRIPTION
31 Pass the \fIpointer\fP that will be untouched by libcurl and passed as the 3rd
32 argument in the ioctl callback set with \fICURLOPT_IOCTLFUNCTION(3)\fP.
33 .SH DEFAULT
34 By default, the value of this parameter is NULL.
35 .SH PROTOCOLS
36 Used with HTTP
37 .SH EXAMPLE
38 .nf
39 static curlioerr ioctl_callback(CURL *handle, int cmd, void *clientp)
40 {
41 struct data *io = (struct data *)clientp;
42 if(cmd == CURLIOCMD_RESTARTREAD) {
43 lseek(fd, 0, SEEK_SET);
44 current_offset = 0;
45 return CURLIOE_OK;
46 }
47 return CURLIOE_UNKNOWNCMD;
48 }
49 {
50 struct data ioctl_data;
51 curl_easy_setopt(curl, CURLOPT_IOCTLFUNCTION, ioctl_callback);
52 curl_easy_setopt(curl, CURLOPT_IOCTLDATA, &ioctl_data);
53 }
54 .fi
55 .SH AVAILABILITY
56 Added in 7.12.3
57 .SH RETURN VALUE
58 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
59 .SH "SEE ALSO"
60 .BR CURLOPT_IOCTLFUNCTION "(3), " CURLOPT_SEEKFUNCTION "(3), "