curl / libcurl / API / curl_easy_setopt / CURLOPT_HEADER

CURLOPT_HEADER explained

NAME

CURLOPT_HEADER - pass headers to the data stream

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HEADER, long onoff);

DESCRIPTION

Pass in onoff set to 1 to tell the library to include the header in the body output for requests with this handle. This option is relevant for protocols that actually have headers or other meta-data (like HTTP and FTP).

When asking to get the header info passed to the same callback as the body, it is not possible to accurately separate them again without detailed knowledge about the protocol in use.

It is often better to use CURLOPT_HEADERFUNCTION to get the header data separately.

While named confusingly similar, CURLOPT_HTTPHEADER is used to set custom HTTP headers!

DEFAULT

0

PROTOCOLS

Most

EXAMPLE

CURL *curl = curl_easy_init();
if(curl) {
  curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
 
  curl_easy_setopt(curl, CURLOPT_HEADER, 1L);
 
  curl_easy_perform(curl);
}

RETURN VALUE

Returns CURLE_OK.

SEE ALSO

CURLOPT_HEADERFUNCTION, CURLOPT_HTTPHEADER

This HTML page was made with roffit.