docs/libcurl/opts/CURLOPT_HEADER.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
   9 .\" *
  10 .\" * This software is licensed as described in the file COPYING, which
  11 .\" * you should have received as part of this distribution. The terms
  12 .\" * are also available at http://curl.haxx.se/docs/copyright.html.
  13 .\" *
  14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15 .\" * copies of the Software, and permit persons to whom the Software is
  16 .\" * furnished to do so, under the terms of the COPYING file.
  17 .\" *
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19 .\" * KIND, either express or implied.
  20 .\" *
  21 .\" **************************************************************************
  22 .\"
  23 .TH CURLOPT_HEADER 3 "16 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_HEADER \- pass headers to the data stream
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HEADER, long onoff);
  30 .SH DESCRIPTION
  31 Pass in \fIonoff\fP set to 1 to tell the library to include the header in the
  32 body output for requests with this \fIhandle\fP. This option is relevant for
  33 protocols that actually have headers or other meta-data (like HTTP and FTP).
  34
  35 When asking to get the header info passed to the same callback as the body, it
  36 is not possible to accurately separate them again without detailed knowledge
  37 about the protocol in use.
  38
  39 It is often better to use \fICURLOPT_HEADERFUNCTION(3)\fP to get the header
  40 data separately.
  41 .SH DEFAULT
  42 0
  43 .SH RETURN VALUE
  44 Returns CURLE_OK.
  45 .SH "SEE ALSO"
  46 .BR CURLOPT_HEADERFUNCTION "(3), "