CURLINFO_REFERER.3 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  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_REFERER 3 "11 Feb 2021" "libcurl 7.76.0" "curl_easy_getinfo options"
  24. .SH NAME
  25. CURLINFO_REFERER \- get the referrer header
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REFERER, char **hdrp);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass in a pointer to a char pointer and get the referrer header.
  33. The \fBhdrp\fP pointer will be NULL or pointing to private memory you MUST NOT
  34. free - it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the
  35. corresponding CURL handle.
  36. .SH PROTOCOLS
  37. HTTP(S)
  38. .SH EXAMPLE
  39. .nf
  40. CURL *curl = curl_easy_init();
  41. if(curl) {
  42. CURLcode res;
  43. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  44. curl_easy_setopt(curl, CURLOPT_REFERER, "https://example.org/referrer");
  45. res = curl_easy_perform(curl);
  46. if(res == CURLE_OK) {
  47. char *hdr = NULL;
  48. curl_easy_getinfo(curl, CURLINFO_REFERER, &hdr);
  49. if(hdr)
  50. printf("Referrer header: %s\\n", hdr);
  51. }
  52. curl_easy_cleanup(curl);
  53. }
  54. .fi
  55. .SH AVAILABILITY
  56. Added in 7.76.0
  57. .SH RETURN VALUE
  58. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  59. .SH "SEE ALSO"
  60. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
  61. .BR CURLOPT_REFERER "(3), "