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