xref: /aosp_15_r20/external/curl/docs/libcurl/opts/CURLINFO_REFERER.md (revision 6236dae45794135f37c4eb022389c904c8b0090d)
1*6236dae4SAndroid Build Coastguard Worker---
2*6236dae4SAndroid Build Coastguard Workerc: Copyright (C) Daniel Stenberg, <[email protected]>, et al.
3*6236dae4SAndroid Build Coastguard WorkerSPDX-License-Identifier: curl
4*6236dae4SAndroid Build Coastguard WorkerTitle: CURLINFO_REFERER
5*6236dae4SAndroid Build Coastguard WorkerSection: 3
6*6236dae4SAndroid Build Coastguard WorkerSource: libcurl
7*6236dae4SAndroid Build Coastguard WorkerSee-also:
8*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_REFERER (3)
9*6236dae4SAndroid Build Coastguard Worker  - curl_easy_getinfo (3)
10*6236dae4SAndroid Build Coastguard Worker  - curl_easy_header (3)
11*6236dae4SAndroid Build Coastguard Worker  - curl_easy_setopt (3)
12*6236dae4SAndroid Build Coastguard WorkerProtocol:
13*6236dae4SAndroid Build Coastguard Worker  - HTTP
14*6236dae4SAndroid Build Coastguard WorkerAdded-in: 7.76.0
15*6236dae4SAndroid Build Coastguard Worker---
16*6236dae4SAndroid Build Coastguard Worker
17*6236dae4SAndroid Build Coastguard Worker# NAME
18*6236dae4SAndroid Build Coastguard Worker
19*6236dae4SAndroid Build Coastguard WorkerCURLINFO_REFERER - get the used referrer request header
20*6236dae4SAndroid Build Coastguard Worker
21*6236dae4SAndroid Build Coastguard Worker# SYNOPSIS
22*6236dae4SAndroid Build Coastguard Worker
23*6236dae4SAndroid Build Coastguard Worker~~~c
24*6236dae4SAndroid Build Coastguard Worker#include <curl/curl.h>
25*6236dae4SAndroid Build Coastguard Worker
26*6236dae4SAndroid Build Coastguard WorkerCURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REFERER, char **hdrp);
27*6236dae4SAndroid Build Coastguard Worker~~~
28*6236dae4SAndroid Build Coastguard Worker
29*6236dae4SAndroid Build Coastguard Worker# DESCRIPTION
30*6236dae4SAndroid Build Coastguard Worker
31*6236dae4SAndroid Build Coastguard WorkerPass in a pointer to a char pointer and get the referrer header used in the
32*6236dae4SAndroid Build Coastguard Workermost recent request.
33*6236dae4SAndroid Build Coastguard Worker
34*6236dae4SAndroid Build Coastguard WorkerThe **hdrp** pointer is NULL or points to private memory you MUST NOT free -
35*6236dae4SAndroid Build Coastguard Workerit gets freed when you call curl_easy_cleanup(3) on the corresponding
36*6236dae4SAndroid Build Coastguard WorkerCURL handle.
37*6236dae4SAndroid Build Coastguard Worker
38*6236dae4SAndroid Build Coastguard Worker# %PROTOCOLS%
39*6236dae4SAndroid Build Coastguard Worker
40*6236dae4SAndroid Build Coastguard Worker# EXAMPLE
41*6236dae4SAndroid Build Coastguard Worker
42*6236dae4SAndroid Build Coastguard Worker~~~c
43*6236dae4SAndroid Build Coastguard Workerint main(void)
44*6236dae4SAndroid Build Coastguard Worker{
45*6236dae4SAndroid Build Coastguard Worker  CURL *curl = curl_easy_init();
46*6236dae4SAndroid Build Coastguard Worker  if(curl) {
47*6236dae4SAndroid Build Coastguard Worker    CURLcode res;
48*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
49*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_REFERER, "https://example.org/referrer");
50*6236dae4SAndroid Build Coastguard Worker    res = curl_easy_perform(curl);
51*6236dae4SAndroid Build Coastguard Worker    if(res == CURLE_OK) {
52*6236dae4SAndroid Build Coastguard Worker      char *hdr = NULL;
53*6236dae4SAndroid Build Coastguard Worker      curl_easy_getinfo(curl, CURLINFO_REFERER, &hdr);
54*6236dae4SAndroid Build Coastguard Worker      if(hdr)
55*6236dae4SAndroid Build Coastguard Worker        printf("Referrer header: %s\n", hdr);
56*6236dae4SAndroid Build Coastguard Worker    }
57*6236dae4SAndroid Build Coastguard Worker    curl_easy_cleanup(curl);
58*6236dae4SAndroid Build Coastguard Worker  }
59*6236dae4SAndroid Build Coastguard Worker}
60*6236dae4SAndroid Build Coastguard Worker~~~
61*6236dae4SAndroid Build Coastguard Worker
62*6236dae4SAndroid Build Coastguard Worker# %AVAILABILITY%
63*6236dae4SAndroid Build Coastguard Worker
64*6236dae4SAndroid Build Coastguard Worker# RETURN VALUE
65*6236dae4SAndroid Build Coastguard Worker
66*6236dae4SAndroid Build Coastguard WorkerReturns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
67