mirror of
https://codeberg.org/kiss-community/repo
synced 2024-12-24 08:20:05 -07:00
49 lines
1.5 KiB
Groff
49 lines
1.5 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLINFO_RESPONSE_CODE.md
|
|
.TH CURLINFO_RESPONSE_CODE 3 "2024-07-29" libcurl
|
|
.SH NAME
|
|
CURLINFO_RESPONSE_CODE \- get the last response code
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_RESPONSE_CODE, long *codep);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a pointer to a long to receive the last received HTTP, FTP, SMTP or LDAP
|
|
(OpenLDAP only) response code. This option was previously known as
|
|
CURLINFO_HTTP_CODE in libcurl 7.10.7 and earlier. The stored value is zero if
|
|
no server response code has been received.
|
|
|
|
Note that a proxy\(aqs CONNECT response should be read with
|
|
\fICURLINFO_HTTP_CONNECTCODE(3)\fP and not this.
|
|
.SH PROTOCOLS
|
|
This functionality affects ftp, http, ldap and smtp
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
CURLcode res;
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
res = curl_easy_perform(curl);
|
|
if(res == CURLE_OK) {
|
|
long response_code;
|
|
curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &response_code);
|
|
}
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
}
|
|
.fi
|
|
.SH NOTES
|
|
The former name, CURLINFO_HTTP_CODE, was added in 7.4.1. Support for SMTP
|
|
responses added in 7.25.0, for OpenLDAP in 7.81.0.
|
|
.SH AVAILABILITY
|
|
Added in curl 7.10.8
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH SEE ALSO
|
|
.BR CURLINFO_HTTP_CONNECTCODE (3),
|
|
.BR curl_easy_getinfo (3),
|
|
.BR curl_easy_setopt (3)
|