Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_HEADEROPT (3)

Name

CURLOPT_HEADEROPT - set how to send HTTP headers

Synopsis

#include <curl/curl.h>

CURLcode  curl_easy_setopt(CURL  *handle,  CURLOPT_HEADEROPT, long bit-
mask);

Description

CURLOPT_HEADEROPT(3)       curl_easy_setopt options       CURLOPT_HEADEROPT(3)



NAME
       CURLOPT_HEADEROPT - set how to send HTTP headers

SYNOPSIS
       #include <curl/curl.h>

       CURLcode  curl_easy_setopt(CURL  *handle,  CURLOPT_HEADEROPT, long bit-
       mask);

DESCRIPTION
       Pass a long that is a bitmask of options of how to deal  with  headers.
       The two mutually exclusive options are:

       CURLHEADER_UNIFIED  -  the  headers  specified in CURLOPT_HTTPHEADER(3)
       will be used in requests both to servers and proxies. With this  option
       enabled, CURLOPT_PROXYHEADER(3) will not have any effect.

       CURLHEADER_SEPARATE - makes CURLOPT_HTTPHEADER(3) headers only get sent
       to a server and not to a proxy. Proxy headers must  be  set  with  CUR-
       LOPT_PROXYHEADER(3)  to get used. Note that if a non-CONNECT request is
       sent to a proxy, libcurl will send both server headers and proxy  head-
       ers. When doing CONNECT, libcurl will send CURLOPT_PROXYHEADER(3) head-
       ers only to the proxy and then CURLOPT_HTTPHEADER(3)  headers  only  to
       the server.

DEFAULT
       CURLHEADER_SEPARATE  (changed in 7.42.1, used CURLHEADER_UNIFIED before
       then)

PROTOCOLS
       HTTP

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         CURLcode ret;
         struct curl_slist *list;
         list = curl_slist_append(NULL, "Shoesize: 10");
         list = curl_slist_append(list, "Accept:");
         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
         curl_easy_setopt(curl, CURLOPT_PROXY, "http://localhost:8080");

         /* HTTPS over a proxy makes a separate CONNECT to the proxy, so tell
            libcurl to not send the custom headers to the proxy. Keep them
            separate! */
         curl_easy_setopt(curl, CURLOPT_HEADEROPT, CURLHEADER_SEPARATE);
         ret = curl_easy_perform(curl);
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.37.0

RETURN VALUE
       Returns CURLE_OK if the option is supported,  and  CURLE_UNKNOWN_OPTION
       if not.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_HTTPHEADER(3), CURLOPT_PROXYHEADER(3),



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was    downloaded    from    https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    19 Jun 2014             CURLOPT_HEADEROPT(3)