DOC HOME SITE MAP MAN PAGES GNU INFO SEARCH PRINT BOOK
 

CURLOPT_ACCEPT_ENCODING(3)





CURLOPT_ACCEPT_ENCODING(3curl_easy_setopt optionCURLOPT_ACCEPT_ENCODING(3)



NAME

     CURLOPT_ACCEPT_ENCODING - enables automatic decompression of
     HTTP downloads


SYNOPSIS

     #include <curl/curl.h>

     CURLcode           curl_easy_setopt(CURL            *handle,
     CURLOPT_ACCEPT_ENCODING, char *enc);


DESCRIPTION

     Pass a char * argument specifying what encoding you'd like.

     Sets the contents of the Accept-Encoding: header sent  in  a
     HTTP  request,  and  enables  decoding  of a response when a
     Content-Encoding: header is received.  Three  encodings  are
     supported:  identity,  meaning non-compressed, deflate which
     requests the server to compress its response using the  zlib
     algorithm, and gzip which requests the gzip algorithm.

     If a zero-length string is set  like  "",  then  an  Accept-
     Encoding: header containing all built-in supported encodings
     is sent.

     Set this option to NULL  to  explicitly  disable  it,  which
     makes  libcurl  not  send an Accept-Encoding: header and not
     decompress contents automatically.

     You can also opt to just include the Accept-Encoding: header
     in  your  request  with CURLOPT_HTTPHEADER(3) but then there
     will be no automatic decompressing when receiving data.

     This is a request, not an order; the server may or  may  not
     do  it.   This option must be set (to any non-NULL value) or
     else any unsolicited encoding done by the server is ignored.

     Servers might respond  with  Content-Encoding  even  without
     getting  a  Accept-Encoding:  in  the request. Servers might
     respond with a  different  Content-Encoding  than  what  was
     asked for in the request.

     The Content-Length: servers send for a  compressed  response
     is supposed to indicate the length of the compressed content
     so when auto decoding is enabled it may not match the sum of
     bytes reported by the write callbacks (although, sending the
     length of the non-compressed content is a common server mis-
     take).

     The application does not have  to  keep  the  string  around
     after setting this option.

libcurl 7.58.0   Last change: December 21, 2016                 1


CURLOPT_ACCEPT_ENCODING(3curl_easy_setopt optionCURLOPT_ACCEPT_ENCODING(3)



DEFAULT

     NULL


PROTOCOLS

     HTTP


EXAMPLE

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

       /* enable all supported built-in compressions */
       curl_easy_setopt(curl, CURLOPT_ACCEPT_ENCODING, "");

       /* Perform the request */
       curl_easy_perform(curl);
     }


AVAILABILITY

     This option was called CURLOPT_ENCODING before 7.21.6


RETURN VALUE

     Returns   CURLE_OK   if    the    option    is    supported,
     CURLE_UNKNOWN_OPTION if not, or CURLE_OUT_OF_MEMORY if there
     was insufficient heap space.


SEE ALSO

     CURLOPT_TRANSFER_ENCODING(3),         CURLOPT_HTTPHEADER(3),
     CURLOPT_HTTP_CONTENT_DECODING(3),

libcurl 7.58.0   Last change: December 21, 2016                 2


Man(1) output converted with man2html