Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_HEADER_SIZE.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2017, 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 https://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 CURLINFO_HEADER_SIZE 3 "May 06, 2017" "libcurl 7.70.0" "curl_easy_getinfo options"
                     24: 
                     25: .SH NAME
                     26: CURLINFO_HEADER_SIZE \- get size of retrieved headers
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_HEADER_SIZE, long *sizep);
                     31: .SH DESCRIPTION
                     32: Pass a pointer to a long to receive the total size of all the headers
                     33: received. Measured in number of bytes.
                     34: 
                     35: The total includes the size of any received headers suppressed by
                     36: \fICURLOPT_SUPPRESS_CONNECT_HEADERS(3)\fP.
                     37: .SH PROTOCOLS
                     38: All
                     39: .SH EXAMPLE
                     40: .nf
                     41: CURL *curl = curl_easy_init();
                     42: if(curl) {
                     43:   CURLcode res;
                     44:   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
                     45:   res = curl_easy_perform(curl);
                     46:   if(res == CURLE_OK) {
                     47:     long size;
                     48:     res = curl_easy_getinfo(curl, CURLINFO_HEADER_SIZE, &size);
                     49:     if(!res)
                     50:       printf("Header size: %ld bytes\\n", size);
                     51:   }
                     52:   curl_easy_cleanup(curl);
                     53: }
                     54: .fi
                     55: .SH AVAILABILITY
                     56: Added in 7.4.1
                     57: .SH RETURN VALUE
                     58: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
                     59: .SH "SEE ALSO"
                     60: .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
                     61: .BR CURLINFO_REQUEST_SIZE "(3), "
                     62: .BR CURLINFO_SIZE_DOWNLOAD "(3), "

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>