Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLINFO_REQUEST_SIZE.3
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_REQUEST_SIZE 3 "May 06, 2017" "libcurl 7.59.0" "curl_easy_getinfo options"
24
25 .SH NAME
26 CURLINFO_REQUEST_SIZE \- get size of sent request
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REQUEST_SIZE, long *sizep);
31 .SH DESCRIPTION
32 Pass a pointer to a long to receive the total size of the issued
33 requests. This is so far only for HTTP requests. Note that this may be more
34 than one request if \fICURLOPT_FOLLOWLOCATION(3)\fP is enabled.
35 .SH PROTOCOLS
36 All
37 .SH EXAMPLE
38 .nf
39 CURL *curl = curl_easy_init();
40 if(curl) {
41   CURLcode res;
42   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
43   res = curl_easy_perform(curl);
44   if(res == CURLE_OK) {
45     long req;
46     res = curl_easy_getinfo(curl, CURLINFO_REQUEST_SIZE, &req);
47     if(!res)
48       printf("Request size: %ld bytes\\n", req);
49   }
50   curl_easy_cleanup(curl);
51 }
52 .fi
53 .SH AVAILABILITY
54 Added in 7.4.1
55 .SH RETURN VALUE
56 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
57 .SH "SEE ALSO"
58 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
59 .BR CURLINFO_HEADER_SIZE "(3), "
60 .BR CURLINFO_SIZE_DOWNLOAD "(3), "