mirror of
https://github.com/curl/curl.git
synced 2024-12-09 06:30:06 +08:00
71 lines
2.3 KiB
Groff
71 lines
2.3 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" * SPDX-License-Identifier: curl
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLINFO_REFERER 3 "11 Feb 2021" libcurl libcurl
|
|
.SH NAME
|
|
CURLINFO_REFERER \- get the referrer header
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REFERER, char **hdrp);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass in a pointer to a char pointer and get the referrer header.
|
|
|
|
The \fBhdrp\fP pointer is NULL or points to private memory you MUST NOT free -
|
|
it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the corresponding
|
|
CURL handle.
|
|
.SH PROTOCOLS
|
|
HTTP(S)
|
|
.SH EXAMPLE
|
|
.nf
|
|
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);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.76.0
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH "SEE ALSO"
|
|
.BR curl_easy_getinfo (3),
|
|
.BR curl_easy_header (3),
|
|
.BR curl_easy_setopt (3),
|
|
.BR CURLOPT_REFERER (3)
|