GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  CURLOPT_HEADER (3)

NAME

CURLOPT_HEADER - pass headers to the data stream

CONTENTS

Synopsis
Description
Default
Protocols
Example
Return Value

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(3) to get the header data separately.

While named confusingly similar, CURLOPT_HTTPHEADER(3) 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(3), CURLOPT_HTTPHEADER(3),
Search for    or go to Top of page |  Section 3 |  Main Index


libcurl 7.37.0 CURLOPT_HEADER (3) 16 Jun 2014

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.