CURLINFO_EFFECTIVE_METHOD.3 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  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 CURLINFO_EFFECTIVE_METHOD 3 "28 Aug 2015" "libcurl 7.72.0" "curl_easy_getinfo options"
  24. .SH NAME
  25. CURLINFO_EFFECTIVE_METHOD \- get the last used HTTP method
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_EFFECTIVE_METHOD,
  30. char **methodp);
  31. .fi
  32. .SH DESCRIPTION
  33. Pass in a pointer to a char pointer and get the last used effective HTTP
  34. method.
  35. In cases when you have asked libcurl to follow redirects, the method may not be
  36. the same method the first request would use.
  37. The \fBmethodp\fP pointer will be NULL or pointing to private memory you MUST
  38. NOT free - it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the
  39. corresponding CURL handle.
  40. .SH PROTOCOLS
  41. HTTP(S)
  42. .SH EXAMPLE
  43. .nf
  44. CURL *curl = curl_easy_init();
  45. if(curl) {
  46. CURLcode res;
  47. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  48. curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "data");
  49. curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
  50. res = curl_easy_perform(curl);
  51. if(res == CURLE_OK) {
  52. char *method = NULL;
  53. curl_easy_getinfo(curl, CURLINFO_EFFECTIVE_METHOD, &method);
  54. if(method)
  55. printf("Redirected to method: %s\\n", method);
  56. }
  57. curl_easy_cleanup(curl);
  58. }
  59. .fi
  60. .SH AVAILABILITY
  61. Added in 7.72.0
  62. .SH RETURN VALUE
  63. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  64. .SH "SEE ALSO"
  65. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "