Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_RESPONSE_CODE.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2020, 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_RESPONSE_CODE 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_getinfo options"
24:
25: .SH NAME
26: CURLINFO_RESPONSE_CODE \- get the last response code
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_RESPONSE_CODE, long *codep);
31: .SH DESCRIPTION
32: Pass a pointer to a long to receive the last received HTTP, FTP or SMTP
33: response code. This option was previously known as CURLINFO_HTTP_CODE in
34: libcurl 7.10.7 and earlier. The stored value will be zero if no server
35: response code has been received. Note that a proxy's CONNECT response should
36: be read with \fICURLINFO_HTTP_CONNECTCODE(3)\fP and not this.
37:
38: Support for SMTP responses added in 7.25.0.
39: .SH PROTOCOLS
40: HTTP, FTP and SMTP
41: .SH EXAMPLE
42: .nf
43: CURL *curl = curl_easy_init();
44: if(curl) {
45: CURLcode res;
46: curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
47: res = curl_easy_perform(curl);
48: if(res == CURLE_OK) {
49: long response_code;
50: curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &response_code);
51: }
52: curl_easy_cleanup(curl);
53: }
54: .fi
55: .SH AVAILABILITY
56: Added in 7.10.8. CURLINFO_HTTP_CODE was 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_HTTP_CONNECTCODE "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>