curl / libcurl / API / curl_easy_setopt / CURLOPT_REFERER

CURLOPT_REFERER explained

Name

CURLOPT_REFERER - the HTTP referer header

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_REFERER, char *where);

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 CURLOPT_HTTPHEADER.

The application does not have to keep the string around after setting this option.

Default

NULL

Protocols

HTTP

Example

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);
  }
}

Availability

If built with HTTP support

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.