CURLOPT_SEEKDATA.3 2.0 KB

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