docs/libcurl/libcurl-errors.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 http://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 libcurl-errors 3 "1 Jan 2010" "libcurl 7.20.0" "libcurl errors"
  24 .SH NAME
  25 libcurl-errors \- error codes in libcurl
  26 .SH DESCRIPTION
  27 This man page includes most, if not all, available error codes in libcurl.
  28 Why they occur and possibly what you can do to fix the problem are also included.
  29 .SH "CURLcode"
  30 Almost all "easy" interface functions return a CURLcode error code. No matter
  31 what, using the \fIcurl_easy_setopt(3)\fP option \fICURLOPT_ERRORBUFFER(3)\fP
  32 is a good idea as it will give you a human readable error string that may
  33 offer more details about the cause of the error than just the error code.
  34 \fIcurl_easy_strerror(3)\fP can be called to get an error string from a given
  35 CURLcode number.
  36
  37 CURLcode is one of the following:
  38 .IP "CURLE_OK (0)"
  39 All fine. Proceed as usual.
  40 .IP "CURLE_UNSUPPORTED_PROTOCOL (1)"
  41 The URL you passed to libcurl used a protocol that this libcurl does not
  42 support. The support might be a compile-time option that you didn't use, it
  43 can be a misspelled protocol string or just a protocol libcurl has no code
  44 for.
  45 .IP "CURLE_FAILED_INIT (2)"
  46 Very early initialization code failed. This is likely to be an internal error
  47 or problem, or a resource problem where something fundamental couldn't get
  48 done at init time.
  49 .IP "CURLE_URL_MALFORMAT (3)"
  50 The URL was not properly formatted.
  51 .IP "CURLE_NOT_BUILT_IN (4)"
  52 A requested feature, protocol or option was not found built-in in this libcurl
  53 due to a build-time decision. This means that a feature or option was not
  54 enabled or explicitly disabled when libcurl was built and in order to get it
  55 to function you have to get a rebuilt libcurl.
  56 .IP "CURLE_COULDNT_RESOLVE_PROXY (5)"
  57 Couldn't resolve proxy. The given proxy host could not be resolved.
  58 .IP "CURLE_COULDNT_RESOLVE_HOST (6)"
  59 Couldn't resolve host. The given remote host was not resolved.
  60 .IP "CURLE_COULDNT_CONNECT (7)"
  61 Failed to connect() to host or proxy.
  62 .IP "CURLE_FTP_WEIRD_SERVER_REPLY (8)"
  63 After connecting to a FTP server, libcurl expects to get a certain reply
  64 back. This error code implies that it got a strange or bad reply. The given
  65 remote server is probably not an OK FTP server.
  66 .IP "CURLE_REMOTE_ACCESS_DENIED (9)"
  67 We were denied access to the resource given in the URL.  For FTP, this occurs
  68 while trying to change to the remote directory.
  69 .IP "CURLE_FTP_ACCEPT_FAILED (10)"
  70 While waiting for the server to connect back when an active FTP session is
  71 used, an error code was sent over the control connection or similar.
  72 .IP "CURLE_FTP_WEIRD_PASS_REPLY (11)"
  73 After having sent the FTP password to the server, libcurl expects a proper
  74 reply. This error code indicates that an unexpected code was returned.
  75 .IP "CURLE_FTP_ACCEPT_TIMEOUT (12)"
  76 During an active FTP session while waiting for the server to connect, the
  77 \fICURLOPT_ACCEPTTIMOUT_MS(3)\fP (or the internal default) timeout expired.
  78 .IP "CURLE_FTP_WEIRD_PASV_REPLY (13)"
  79 libcurl failed to get a sensible result back from the server as a response to
  80 either a PASV or a EPSV command. The server is flawed.
  81 .IP "CURLE_FTP_WEIRD_227_FORMAT (14)"
  82 FTP servers return a 227-line as a response to a PASV command. If libcurl
  83 fails to parse that line, this return code is passed back.
  84 .IP "CURLE_FTP_CANT_GET_HOST (15)"
  85 An internal failure to lookup the host used for the new connection.
  86 .IP "CURLE_FTP_COULDNT_SET_TYPE (17)"
  87 Received an error when trying to set the transfer mode to binary or ASCII.
  88 .IP "CURLE_PARTIAL_FILE (18)"
  89 A file transfer was shorter or larger than expected. This happens when the
  90 server first reports an expected transfer size, and then delivers data that
  91 doesn't match the previously given size.
  92 .IP "CURLE_FTP_COULDNT_RETR_FILE (19)"
  93 This was either a weird reply to a 'RETR' command or a zero byte transfer
  94 complete.
  95 .IP "CURLE_QUOTE_ERROR (21)"
  96 When sending custom "QUOTE" commands to the remote server, one of the commands
  97 returned an error code that was 400 or higher (for FTP) or otherwise
  98 indicated unsuccessful completion of the command.
  99 .IP "CURLE_HTTP_RETURNED_ERROR (22)"
 100 This is returned if \fICURLOPT_FAILONERROR(3)\fP is set TRUE and the HTTP
 101 server returns an error code that is >= 400.
 102 .IP "CURLE_WRITE_ERROR (23)"
 103 An error occurred when writing received data to a local file, or an error was
 104 returned to libcurl from a write callback.
 105 .IP "CURLE_UPLOAD_FAILED (25)"
 106 Failed starting the upload. For FTP, the server typically denied the STOR
 107 command. The error buffer usually contains the server's explanation for this.
 108 .IP "CURLE_READ_ERROR (26)"
 109 There was a problem reading a local file or an error returned by the read
 110 callback.
 111 .IP "CURLE_OUT_OF_MEMORY (27)"
 112 A memory allocation request failed. This is serious badness and
 113 things are severely screwed up if this ever occurs.
 114 .IP "CURLE_OPERATION_TIMEDOUT (28)"
 115 Operation timeout. The specified time-out period was reached according to the
 116 conditions.
 117 .IP "CURLE_FTP_PORT_FAILED (30)"
 118 The FTP PORT command returned error. This mostly happens when you haven't
 119 specified a good enough address for libcurl to use. See
 120 \fICURLOPT_FTPPORT(3)\fP.
 121 .IP "CURLE_FTP_COULDNT_USE_REST (31)"
 122 The FTP REST command returned error. This should never happen if the server is
 123 sane.
 124 .IP "CURLE_RANGE_ERROR (33)"
 125 The server does not support or accept range requests.
 126 .IP "CURLE_HTTP_POST_ERROR (34)"
 127 This is an odd error that mainly occurs due to internal confusion.
 128 .IP "CURLE_SSL_CONNECT_ERROR (35)"
 129 A problem occurred somewhere in the SSL/TLS handshake. You really want the
 130 error buffer and read the message there as it pinpoints the problem slightly
 131 more. Could be certificates (file formats, paths, permissions), passwords, and
 132 others.
 133 .IP "CURLE_BAD_DOWNLOAD_RESUME (36)"
 134 The download could not be resumed because the specified offset was out of the
 135 file boundary.
 136 .IP "CURLE_FILE_COULDNT_READ_FILE (37)"
 137 A file given with FILE:// couldn't be opened. Most likely because the file
 138 path doesn't identify an existing file. Did you check file permissions?
 139 .IP "CURLE_LDAP_CANNOT_BIND (38)"
 140 LDAP cannot bind. LDAP bind operation failed.
 141 .IP "CURLE_LDAP_SEARCH_FAILED (39)"
 142 LDAP search failed.
 143 .IP "CURLE_FUNCTION_NOT_FOUND (41)"
 144 Function not found. A required zlib function was not found.
 145 .IP "CURLE_ABORTED_BY_CALLBACK (42)"
 146 Aborted by callback. A callback returned "abort" to libcurl.
 147 .IP "CURLE_BAD_FUNCTION_ARGUMENT (43)"
 148 Internal error. A function was called with a bad parameter.
 149 .IP "CURLE_INTERFACE_FAILED (45)"
 150 Interface error. A specified outgoing interface could not be used. Set which
 151 interface to use for outgoing connections' source IP address with
 152 \fICURLOPT_INTERFACE(3)\fP.
 153 .IP "CURLE_TOO_MANY_REDIRECTS (47)"
 154 Too many redirects. When following redirects, libcurl hit the maximum amount.
 155 Set your limit with \fICURLOPT_MAXREDIRS(3)\fP.
 156 .IP "CURLE_UNKNOWN_OPTION (48)"
 157 An option passed to libcurl is not recognized/known. Refer to the appropriate
 158 documentation. This is most likely a problem in the program that uses
 159 libcurl. The error buffer might contain more specific information about which
 160 exact option it concerns.
 161 .IP "CURLE_TELNET_OPTION_SYNTAX (49)"
 162 A telnet option string was Illegally formatted.
 163 .IP "CURLE_PEER_FAILED_VERIFICATION (51)"
 164 The remote server's SSL certificate or SSH md5 fingerprint was deemed not OK.
 165 .IP "CURLE_GOT_NOTHING (52)"
 166 Nothing was returned from the server, and under the circumstances, getting
 167 nothing is considered an error.
 168 .IP "CURLE_SSL_ENGINE_NOTFOUND (53)"
 169 The specified crypto engine wasn't found.
 170 .IP "CURLE_SSL_ENGINE_SETFAILED (54)"
 171 Failed setting the selected SSL crypto engine as default!
 172 .IP "CURLE_SEND_ERROR (55)"
 173 Failed sending network data.
 174 .IP "CURLE_RECV_ERROR (56)"
 175 Failure with receiving network data.
 176 .IP "CURLE_SSL_CERTPROBLEM (58)"
 177 problem with the local client certificate.
 178 .IP "CURLE_SSL_CIPHER (59)"
 179 Couldn't use specified cipher.
 180 .IP "CURLE_SSL_CACERT (60)"
 181 Peer certificate cannot be authenticated with known CA certificates.
 182 .IP "CURLE_BAD_CONTENT_ENCODING (61)"
 183 Unrecognized transfer encoding.
 184 .IP "CURLE_LDAP_INVALID_URL (62)"
 185 Invalid LDAP URL.
 186 .IP "CURLE_FILESIZE_EXCEEDED (63)"
 187 Maximum file size exceeded.
 188 .IP "CURLE_USE_SSL_FAILED (64)"
 189 Requested FTP SSL level failed.
 190 .IP "CURLE_SEND_FAIL_REWIND (65)"
 191 When doing a send operation curl had to rewind the data to retransmit, but the
 192 rewinding operation failed.
 193 .IP "CURLE_SSL_ENGINE_INITFAILED (66)"
 194 Initiating the SSL Engine failed.
 195 .IP "CURLE_LOGIN_DENIED (67)"
 196 The remote server denied curl to login (Added in 7.13.1)
 197 .IP "CURLE_TFTP_NOTFOUND (68)"
 198 File not found on TFTP server.
 199 .IP "CURLE_TFTP_PERM (69)"
 200 Permission problem on TFTP server.
 201 .IP "CURLE_REMOTE_DISK_FULL (70)"
 202 Out of disk space on the server.
 203 .IP "CURLE_TFTP_ILLEGAL (71)"
 204 Illegal TFTP operation.
 205 .IP "CURLE_TFTP_UNKNOWNID (72)"
 206 Unknown TFTP transfer ID.
 207 .IP "CURLE_REMOTE_FILE_EXISTS (73)"
 208 File already exists and will not be overwritten.
 209 .IP "CURLE_TFTP_NOSUCHUSER (74)"
 210 This error should never be returned by a properly functioning TFTP server.
 211 .IP "CURLE_CONV_FAILED (75)"
 212 Character conversion failed.
 213 .IP "CURLE_CONV_REQD (76)"
 214 Caller must register conversion callbacks.
 215 .IP "CURLE_SSL_CACERT_BADFILE (77)"
 216 Problem with reading the SSL CA cert (path? access rights?)
 217 .IP "CURLE_REMOTE_FILE_NOT_FOUND (78)"
 218 The resource referenced in the URL does not exist.
 219 .IP "CURLE_SSH (79)"
 220 An unspecified error occurred during the SSH session.
 221 .IP "CURLE_SSL_SHUTDOWN_FAILED (80)"
 222 Failed to shut down the SSL connection.
 223 .IP "CURLE_AGAIN (81)"
 224 Socket is not ready for send/recv wait till it's ready and try again. This
 225 return code is only returned from \fIcurl_easy_recv(3)\fP and
 226 \fIcurl_easy_send(3)\fP (Added in 7.18.2)
 227 .IP "CURLE_SSL_CRL_BADFILE (82)"
 228 Failed to load CRL file (Added in 7.19.0)
 229 .IP "CURLE_SSL_ISSUER_ERROR (83)"
 230 Issuer check failed (Added in 7.19.0)
 231 .IP "CURLE_FTP_PRET_FAILED (84)"
 232 The FTP server does not understand the PRET command at all or does not support
 233 the given argument. Be careful when using \fICURLOPT_CUSTOMREQUEST(3)\fP, a
 234 custom LIST command will be sent with PRET CMD before PASV as well. (Added in
 235 7.20.0)
 236 .IP "CURLE_RTSP_CSEQ_ERROR (85)"
 237 Mismatch of RTSP CSeq numbers.
 238 .IP "CURLE_RTSP_SESSION_ERROR (86)"
 239 Mismatch of RTSP Session Identifiers.
 240 .IP "CURLE_FTP_BAD_FILE_LIST (87)"
 241 Unable to parse FTP file list (during FTP wildcard downloading).
 242 .IP "CURLE_CHUNK_FAILED (88)"
 243 Chunk callback reported error.
 244 .IP "CURLE_NO_CONNECTION_AVAILABLE (89)"
 245 (For internal use only, will never be returned by libcurl) No connection
 246 available, the session will be queued. (added in 7.30.0)
 247 .IP "CURLE_OBSOLETE*"
 248 These error codes will never be returned. They were used in an old libcurl
 249 version and are currently unused.
 250 .SH "CURLMcode"
 251 This is the generic return code used by functions in the libcurl multi
 252 interface. Also consider \fIcurl_multi_strerror(3)\fP.
 253 .IP "CURLM_CALL_MULTI_PERFORM (-1)"
 254 This is not really an error. It means you should call
 255 \fIcurl_multi_perform(3)\fP again without doing select() or similar in
 256 between. Before version 7.20.0 this could be returned by
 257 \fIcurl_multi_perform(3)\fP, but in later versions this return code is never
 258 used.
 259 .IP "CURLM_OK (0)"
 260 Things are fine.
 261 .IP "CURLM_BAD_HANDLE (1)"
 262 The passed-in handle is not a valid CURLM handle.
 263 .IP "CURLM_BAD_EASY_HANDLE (2)"
 264 An easy handle was not good/valid. It could mean that it isn't an easy handle
 265 at all, or possibly that the handle already is in used by this or another
 266 multi handle.
 267 .IP "CURLM_OUT_OF_MEMORY (3)"
 268 You are doomed.
 269 .IP "CURLM_INTERNAL_ERROR (4)"
 270 This can only be returned if libcurl bugs. Please report it to us!
 271 .IP "CURLM_BAD_SOCKET (5)"
 272 The passed-in socket is not a valid one that libcurl already knows about.
 273 (Added in 7.15.4)
 274 .IP "CURLM_UNKNOWN_OPTION (6)"
 275 curl_multi_setopt() with unsupported option
 276 (Added in 7.15.4)
 277 .IP "CURLM_ADDED_ALREADY (7)"
 278 An easy handle already added to a multi handle was attempted to get added a
 279 second time. (Added in 7.32.1)
 280 .SH "CURLSHcode"
 281 The "share" interface will return a CURLSHcode to indicate when an error has
 282 occurred.  Also consider \fIcurl_share_strerror(3)\fP.
 283 .IP "CURLSHE_OK (0)"
 284 All fine. Proceed as usual.
 285 .IP "CURLSHE_BAD_OPTION (1)"
 286 An invalid option was passed to the function.
 287 .IP "CURLSHE_IN_USE (2)"
 288 The share object is currently in use.
 289 .IP "CURLSHE_INVALID (3)"
 290 An invalid share object was passed to the function.
 291 .IP "CURLSHE_NOMEM (4)"
 292 Not enough memory was available.
 293 (Added in 7.12.0)
 294 .IP "CURLSHE_NOT_BUILT_IN (5)"
 295 The requested sharing could not be done because the library you use don't have
 296 that particular feature enabled. (Added in 7.23.0)