Blame view

3rdparty/curl/share/man/man3/CURLOPT_NOBODY.3 2.67 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
63
64
65
66
67
68
69
70
71
  .\" **************************************************************************
  .\" *                                  _   _ ____  _
  .\" *  Project                     ___| | | |  _ \| |
  .\" *                             / __| | | | |_) | |
  .\" *                            | (__| |_| |  _ <| |___
  .\" *                             \___|\___/|_| \_\_____|
  .\" *
  .\" * Copyright (C) 1998 - 2020, 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 CURLOPT_NOBODY 3 "November 04, 2020" "libcurl 7.77.0" "curl_easy_setopt options"
  
  .SH NAME
  CURLOPT_NOBODY \- do the download request without getting the body
  .SH SYNOPSIS
  #include <curl/curl.h>
  
  CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOBODY, long opt);
  .SH DESCRIPTION
  A long parameter set to 1 tells libcurl to not include the body-part in the
  output when doing what would otherwise be a download. For HTTP(S), this makes
  libcurl do a HEAD request. For most other protocols it means just not asking
  to transfer the body data.
  
  For HTTP operations when \fICURLOPT_NOBODY(3)\fP has been set, unsetting the
  option (with 0) will make it a GET again - only if the method is still set to
  be HEAD. The proper way to get back to a GET request is to set
  \fICURLOPT_HTTPGET(3)\fP and for other methods, use the POST or UPLOAD
  options.
  
  Enabling \fICURLOPT_NOBODY(3)\fP means asking for a download without a body.
  
  If you do a transfer with HTTP that involves a method other than HEAD, you
  will get a body (unless the resource and server sends a zero byte body for the
  specific URL you request).
  .SH DEFAULT
  0, the body is transferred
  .SH PROTOCOLS
  Most
  .SH EXAMPLE
  .nf
  curl = curl_easy_init();
  if(curl) {
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  
    /* get us the resource without a body - use HEAD! */
    curl_easy_setopt(curl, CURLOPT_NOBODY, 1L);
  
    /* Perform the request */
    curl_easy_perform(curl);
  }
  .fi
  .SH AVAILABILITY
  Always
  .SH RETURN VALUE
  Returns CURLE_OK
  .SH "SEE ALSO"
  .BR CURLOPT_HTTPGET "(3), " CURLOPT_POSTFIELDS "(3), " CURLOPT_UPLOAD "(3), "
  .BR CURLOPT_REQUEST_TARGET "(3), " CURLOPT_MIMEPOST "(3), "