Blame view

3rdparty/curl/share/man/man3/CURLOPT_IOCTLDATA.3 2.2 KB
a86c63ca   Hu Chunming   提交三方库文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
  .\" **************************************************************************
  .\" *                                  _   _ ____  _
  .\" *  Project                     ___| | | |  _ \| |
  .\" *                             / __| | | | |_) | |
  .\" *                            | (__| |_| |  _ <| |___
  .\" *                             \___|\___/|_| \_\_____|
  .\" *
  .\" * Copyright (C) 1998 - 2017, 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.
  .\" *
  .\" **************************************************************************
  .\"
  .TH CURLOPT_IOCTLDATA 3 "November 04, 2020" "libcurl 7.77.0" "curl_easy_setopt options"
  
  .SH NAME
  CURLOPT_IOCTLDATA \- custom pointer passed to I/O callback
  .SH SYNOPSIS
  #include <curl/curl.h>
  
  CURLcode curl_easy_setopt(CURL *handle, CURLOPT_IOCTLDATA, void *pointer);
  .SH DESCRIPTION
  Pass the \fIpointer\fP that will be untouched by libcurl and passed as the 3rd
  argument in the ioctl callback set with \fICURLOPT_IOCTLFUNCTION(3)\fP.
  .SH DEFAULT
  By default, the value of this parameter is NULL.
  .SH PROTOCOLS
  Used with HTTP
  .SH EXAMPLE
  .nf
  static curlioerr ioctl_callback(CURL *handle, int cmd, void *clientp)
  {
    struct data *io = (struct data *)clientp;
    if(cmd == CURLIOCMD_RESTARTREAD) {
      lseek(fd, 0, SEEK_SET);
      current_offset = 0;
      return CURLIOE_OK;
    }
    return CURLIOE_UNKNOWNCMD;
  }
  {
    struct data ioctl_data;
    curl_easy_setopt(curl, CURLOPT_IOCTLFUNCTION, ioctl_callback);
    curl_easy_setopt(curl, CURLOPT_IOCTLDATA, &ioctl_data);
  }
  .fi
  .SH AVAILABILITY
  Added in 7.12.3
  .SH RETURN VALUE
  Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  .SH "SEE ALSO"
  .BR CURLOPT_IOCTLFUNCTION "(3), " CURLOPT_SEEKFUNCTION "(3), "