curl / libcurl / API / curl_easy_getinfo / CURLINFO_RESPONSE_CODE

CURLINFO_RESPONSE_CODE explained

Name

CURLINFO_RESPONSE_CODE - get the last response code

Synopsis

#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 and not this.

Protocols

This functionality affects ftp, http, ldap and smtp

Example

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

Added in curl 7.10.8

Return value

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.

See also

CURLINFO_HTTP_CONNECTCODE(3), curl_easy_getinfo(3), curl_easy_setopt(3)

This HTML page was made with roffit.