CURLOPT_REQUEST_TARGET.3 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  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_REQUEST_TARGET 3 "June 21, 2017" "libcurl 7.61.1" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_REQUEST_TARGET \- specify an alternative target for this request
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_REQUEST_TARGET, string);
  29. .SH DESCRIPTION
  30. Pass a char * to string which libcurl uses in the upcoming request instead of
  31. the path as extracted from the URL.
  32. .SH DEFAULT
  33. NULL
  34. .SH PROTOCOLS
  35. HTTP
  36. .SH EXAMPLE
  37. .nf
  38. curl = curl_easy_init();
  39. if(curl) {
  40. curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/*");
  41. curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "OPTIONS");
  42. /* issue an OPTIONS * request (no leading slash) */
  43. curl_easy_setopt(curl, CURLOPT_REQUEST_TARGET, "*");
  44. /* Perform the request */
  45. curl_easy_perform(curl);
  46. }
  47. .fi
  48. .SH AVAILABILITY
  49. Added in 7.55.0
  50. .SH RETURN VALUE
  51. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  52. .SH "SEE ALSO"
  53. .BR CURLOPT_CUSTOMREQUEST "(3), " CURLOPT_HTTPGET "(3), "