e694c8284a
Expand a little. - mention the type name of the return code - avoid stating which exact return codes that might be returned, as that varies over time, builds and conditions - avoid stating some always return OK - refer to the manpage documenting all the return codes Closes #15900
75 lines
1.6 KiB
Markdown
75 lines
1.6 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLINFO_RESPONSE_CODE
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLINFO_HTTP_CONNECTCODE (3)
|
|
- curl_easy_getinfo (3)
|
|
- curl_easy_setopt (3)
|
|
Protocol:
|
|
- HTTP
|
|
- FTP
|
|
- SMTP
|
|
- LDAP
|
|
Added-in: 7.10.8
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLINFO_RESPONSE_CODE - get the last response code
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_RESPONSE_CODE, long *codep);
|
|
~~~
|
|
|
|
# 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's CONNECT response should be read with
|
|
CURLINFO_HTTP_CONNECTCODE(3) and not this.
|
|
|
|
# %PROTOCOLS%
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
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);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# 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.
|
|
|
|
# %AVAILABILITY%
|
|
|
|
# RETURN VALUE
|
|
|
|
curl_easy_getinfo(3) returns a CURLcode indicating success or error.
|
|
|
|
CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
|
|
libcurl-errors(3).
|