plucky (3) CURLINFO_REFERER.3.gz

Provided by: libcurl4-doc_8.12.1-2ubuntu1_all bug

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 gets freed when you call
       curl_easy_cleanup(3) 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(3) returns a CURLcode indicating success or error.

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

SEE ALSO

       CURLOPT_REFERER(3), curl_easy_getinfo(3), curl_easy_header(3), curl_easy_setopt(3)