| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748 |
- .\" generated by cd2nroff 0.1 from CURLINFO_REFERER.md
- .TH CURLINFO_REFERER 3 "2025-01-17" libcurl
- .SH NAME
- CURLINFO_REFERER \- get the used referrer request header
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REFERER, char **hdrp);
- .fi
- .SH DESCRIPTION
- Pass in a pointer to a char pointer and get the referrer header used in the
- most recent request.
- The \fBhdrp\fP pointer is NULL or points to private memory you MUST NOT free \-
- it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the corresponding
- CURL handle.
- .SH PROTOCOLS
- This functionality affects http only
- .SH EXAMPLE
- .nf
- int main(void)
- {
- CURL *curl = curl_easy_init();
- if(curl) {
- CURLcode res;
- curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
- curl_easy_setopt(curl, CURLOPT_REFERER, "https://example.org/referrer");
- res = curl_easy_perform(curl);
- if(res == CURLE_OK) {
- char *hdr = NULL;
- curl_easy_getinfo(curl, CURLINFO_REFERER, &hdr);
- if(hdr)
- printf("Referrer header: %s\\n", hdr);
- }
- curl_easy_cleanup(curl);
- }
- }
- .fi
- .SH AVAILABILITY
- Added in curl 7.76.0
- .SH RETURN VALUE
- Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- .SH SEE ALSO
- .BR CURLOPT_REFERER (3),
- .BR curl_easy_getinfo (3),
- .BR curl_easy_header (3),
- .BR curl_easy_setopt (3)
|
