2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from CURLOPT_REFERER.md
|
2024-12-25 11:28:33 -07:00
|
|
|
.TH CURLOPT_REFERER 3 "2024-12-25" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
|
|
|
|
CURLOPT_REFERER \- the HTTP referer header
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_REFERER, char *where);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
Pass a pointer to a null\-terminated string as parameter. It is used to set the
|
|
|
|
|
Referer: header field in the HTTP request sent to the remote server. You can
|
|
|
|
|
set any custom header with \fICURLOPT_HTTPHEADER(3)\fP.
|
|
|
|
|
|
|
|
|
|
The application does not have to keep the string around after setting this
|
|
|
|
|
option.
|
2024-09-15 18:10:01 -06:00
|
|
|
|
|
|
|
|
Using this option multiple times makes the last set string override the
|
|
|
|
|
previous ones. Set it to NULL to disable its use again.
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH DEFAULT
|
|
|
|
|
NULL
|
|
|
|
|
.SH PROTOCOLS
|
2024-07-29 18:00:04 -06:00
|
|
|
This functionality affects http only
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH EXAMPLE
|
|
|
|
|
.nf
|
|
|
|
|
int main(void)
|
|
|
|
|
{
|
|
|
|
|
CURL *curl = curl_easy_init();
|
|
|
|
|
if(curl) {
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
|
|
|
|
|
|
|
|
/* tell it where we found the link to this place */
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_REFERER, "https://example.org/me.html");
|
|
|
|
|
|
|
|
|
|
curl_easy_perform(curl);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.fi
|
|
|
|
|
.SH AVAILABILITY
|
2024-07-29 18:00:04 -06:00
|
|
|
Added in curl 7.1
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Returns CURLE_OK if HTTP support is enabled, CURLE_UNKNOWN_OPTION if not, or
|
|
|
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR CURLINFO_REDIRECT_URL (3),
|
|
|
|
|
.BR CURLINFO_REFERER (3),
|
|
|
|
|
.BR CURLOPT_HTTPHEADER (3),
|
|
|
|
|
.BR CURLOPT_USERAGENT (3)
|
