CURLOPT_SEEKDATA.3 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 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.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. .\" * SPDX-License-Identifier: curl
  22. .\" *
  23. .\" **************************************************************************
  24. .\"
  25. .TH CURLOPT_SEEKDATA 3 "16 Jun 2014" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_SEEKDATA \- pointer passed to the seek callback
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SEEKDATA, void *pointer);
  32. .fi
  33. .SH DESCRIPTION
  34. Data \fIpointer\fP to pass to the seek callback function. If you use the
  35. \fICURLOPT_SEEKFUNCTION(3)\fP option, this is the pointer you will get as
  36. input.
  37. .SH DEFAULT
  38. If you do not set this, NULL is passed to the callback.
  39. .SH PROTOCOLS
  40. HTTP, FTP, SFTP
  41. .SH EXAMPLE
  42. .nf
  43. static int seek_cb(void *clientp, curl_off_t offset, int origin)
  44. {
  45. struct data *d = (struct data *)clientp;
  46. lseek(d->our_fd, offset, origin);
  47. return CURL_SEEKFUNC_OK;
  48. }
  49. {
  50. struct data seek_data;
  51. curl_easy_setopt(CURL *handle, CURLOPT_SEEKFUNCTION, seek_cb);
  52. curl_easy_setopt(CURL *handle, CURLOPT_SEEKDATA, &seek_data);
  53. }
  54. .fi
  55. .SH AVAILABILITY
  56. Added in 7.18.0
  57. .SH RETURN VALUE
  58. .SH "SEE ALSO"
  59. .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "