Blame view

3rdparty/curl/share/man/man3/CURLINFO_REFERER.3 2.23 KB
a86c63ca   Hu Chunming   提交三方库文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
  .\" **************************************************************************
  .\" *                                  _   _ ____  _
  .\" *  Project                     ___| | | |  _ \| |
  .\" *                             / __| | | | |_) | |
  .\" *                            | (__| |_| |  _ <| |___
  .\" *                             \___|\___/|_| \_\_____|
  .\" *
  .\" * Copyright (C) 1998 - 2021, 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.
  .\" *
  .\" **************************************************************************
  .\"
  .TH CURLINFO_REFERER 3 "February 19, 2021" "libcurl 7.77.0" "curl_easy_getinfo options"
  
  .SH NAME
  CURLINFO_REFERER \- get the referrer header
  .SH SYNOPSIS
  #include <curl/curl.h>
  
  CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REFERER, char **hdrp);
  .SH DESCRIPTION
  Pass in a pointer to a char pointer and get the referrer header.
  
  The \fBhdrp\fP pointer will be NULL or pointing 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
  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), " curl_easy_setopt "(3), "
  .BR CURLOPT_REFERER "(3), "