CURLOPT_REQUEST_TARGET.3 2.0 KB

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