docs/libcurl/opts/CURLINFO_RESPONSE_CODE.3

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