curl / libcurl / API / curl_easy_getinfo / CURLINFO_REFERER

CURLINFO_REFERER explained

Name

CURLINFO_REFERER - get the used referrer request header

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REFERER, char **hdrp);

Description

Pass in a pointer to a char pointer and get the referrer header used in the most recent request.

The hdrp pointer is NULL or points to private memory. You must not free it. The memory gets freed automatically when you call curl_easy_cleanup on the corresponding curl handle.

Protocols

This functionality affects http only

Example

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

Availability

Added in curl 7.76.0

Return value

curl_easy_getinfo returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors.