neo/curl/docs/libcurl/libcurl-errors.3

   1 .\" You can view this file with:
   2 .\" nroff -man [file]
   3 .\" $Id: libcurl-errors.3,v 1.10 2004/03/08 13:57:38 bagder Exp $
   4 .\"
   5 .TH libcurl-errors 3 "8 Mar 2004" "libcurl 7.11.0" "libcurl errors"
   6 .SH NAME
   7 libcurl-errors \- error codes in libcurl
   8 .SH DESCRIPTION
   9 This man page includes most, if not all, available error codes in libcurl.
  10 Why they occur and possibly what you can do to fix the problem.
  11 .SH "CURLcode"
  12 Almost all "easy" interface functions return a CURLcode error code. No matter
  13 what, using \fICURLOPT_ERRORBUFFER\fP is a good idea as it will give you a
  14 human readable error string that may offer more details about the error cause
  15 than just the error code does.
  16
  17 CURLcode is one of the following:
  18 .IP "CURLE_OK (0)"
  19 All fine. Proceed as usual.
  20 .IP "CURLE_UNSUPPORTED_PROTOCOL (1)"
  21 The URL you passed to libcurl used a protocol that this libcurl does not
  22 support. The support might be a compile-time option that you didn't use, it
  23 can be a misspelled protocol string or just a protocol libcurl has no code
  24 for.
  25 .IP "CURLE_FAILED_INIT (2)"
  26 Very early initialization code failed. This is likely to be an internal error
  27 or problem.
  28 .IP "CURLE_URL_MALFORMAT (3)"
  29 The URL was not properly formatted.
  30 .IP "CURLE_URL_MALFORMAT_USER (4)"
  31 URL user malformatted. The user-part of the URL syntax was not correct.
  32 .IP "CURLE_COULDNT_RESOLVE_PROXY (5)"
  33 Couldn't resolve proxy. The given proxy host could not be resolved.
  34 .IP "CURLE_COULDNT_RESOLVE_HOST (6)"
  35 Couldn't resolve host. The given remote host was not resolved.
  36 .IP "CURLE_COULDNT_CONNECT (7)"
  37 Failed to connect() to host or proxy.
  38 .IP "CURLE_FTP_WEIRD_SERVER_REPLY (8)"
  39 After connecting to a FTP server, libcurl expects to get a certain reply back.
  40 This error code implies that it god a strange or bad reply. The given remote
  41 server is probably not an OK FTP server.
  42 .IP "CURLE_FTP_ACCESS_DENIED (9)"
  43 We were denied access when trying to login to an FTP server or when trying to
  44 change working directory to the one given in the URL.
  45 .IP "CURLE_FTP_USER_PASSWORD_INCORRECT (10)"
  46 The username and/or the password were incorrect when trying to login to an FTP
  47 server.
  48 .IP "CURLE_FTP_WEIRD_PASS_REPLY (11)"
  49 After having sent the FTP password to the server, libcurl expects a proper
  50 reply. This error code indicates that an unexpected code was returned.
  51 .IP "CURLE_FTP_WEIRD_USER_REPLY (12)"
  52 After having sent user name to the FTP server, libcurl expects a proper
  53 reply. This error code indicates that an unexpected code was returned.
  54 .IP "CURLE_FTP_WEIRD_PASV_REPLY (13)"
  55 libcurl failed to get a sensible result back from the server as a response to
  56 either a PASV or a EPSV command. The server is flawed.
  57 .IP "CURLE_FTP_WEIRD_227_FORMAT (14)"
  58 FTP servers return a 227-line as a response to a PASV command. If libcurl
  59 fails to parse that line, this return code is passed back.
  60 .IP "CURLE_FTP_CANT_GET_HOST (15)"
  61 An internal failure to lookup the host used for the new connection.
  62 .IP "CURLE_FTP_CANT_RECONNECT (16)"
  63 A bad return code on either PASV or EPSV was sent by the FTP server,
  64 preventing libcurl from being able to continue.
  65 .IP "CURLE_FTP_COULDNT_SET_BINARY (17)"
  66 Received an error when trying to set the transfer mode to binary.
  67 .IP "CURLE_PARTIAL_FILE (18)"
  68 A file transfer was shorter or larger than expected. This happens when the
  69 server first reports an expected transfer size, and then delivers data that
  70 doesn't match the previously given size.
  71 .IP "CURLE_FTP_COULDNT_RETR_FILE (19)"
  72 This was either a weird reply to a 'RETR' command or a zero byte transfer
  73 complete.
  74 .IP "CURLE_FTP_WRITE_ERROR (20)"
  75 After a completed file transfer, the FTP server did not respond a proper
  76 \"transfer successful\" code.
  77 .IP "CURLE_FTP_QUOTE_ERROR (21)"
  78 When sending custom "QUOTE" commands to the remote server, one of the commands
  79 returned an error code that was 400 or higher.
  80 .IP "CURLE_HTTP_RETURNED_ERROR (22)"
  81 This is returned if CURLOPT_FAILONERROR is set TRUE and the HTTP server
  82 returns an error code that is >= 400.
  83 .IP "CURLE_WRITE_ERROR (23)"
  84 An error occurred when writing received data to a local file, or an error was
  85 returned to libcurl from a write callback.
  86 .IP "CURLE_MALFORMAT_USER (24)"
  87 Malformat user. User name badly specified. *Not currently used*
  88 .IP "CURLE_FTP_COULDNT_STOR_FILE (25)"
  89 FTP couldn't STOR file. The server denied the STOR operation. The error buffer
  90 usually contains the server's explanation to this.
  91 .IP "CURLE_READ_ERROR (26)"
  92 There was a problem reading a local file or an error returned by the read
  93 callback.
  94 .IP "CURLE_OUT_OF_MEMORY (27)"
  95 Out of memory. A memory allocation request failed. This is serious badness and
  96 things are severly screwed up if this ever occur.
  97 .IP "CURLE_OPERATION_TIMEOUTED (28)"
  98 Operation timeout. The specified time-out period was reached according to the
  99 conditions.
 100 .IP "CURLE_FTP_COULDNT_SET_ASCII (29)"
 101 libcurl failed to set ASCII transfer type (TYPE A).
 102 .IP "CURLE_FTP_PORT_FAILED (30)"
 103 The FTP PORT command returned error. This mostly happen when you haven't
 104 specified a good enough address for libcurl to use. See \fICURLOPT_FTPPORT\fP.
 105 .IP "CURLE_FTP_COULDNT_USE_REST (31)"
 106 The FTP REST command returned error. This should never happen if the server is
 107 sane.
 108 .IP "CURLE_FTP_COULDNT_GET_SIZE (32)"
 109 The FTP SIZE command returned errror. SIZE is not a kosher FTP command, it is
 110 an extension and not all servers support it. This is not a surprising error.
 111 .IP "CURLE_HTTP_RANGE_ERROR (33)"
 112 The HTTP server does not support or accept range requests.
 113 .IP "CURLE_HTTP_POST_ERROR (34)"
 114 This is an odd error that mainly occurs due to internal confusion.
 115 .IP "CURLE_SSL_CONNECT_ERROR (35)"
 116 A problem occured somewhere in the SSL/TLS handshake. You really want the
 117 error buffer and read the message there as it pinpoints the problem slightly
 118 more. Could be certificates (file formats, paths, permissions), passwords, and
 119 others.
 120 .IP "CURLE_FTP_BAD_DOWNLOAD_RESUME (36)"
 121 Attempting FTP resume beyond file size.
 122 .IP "CURLE_FILE_COULDNT_READ_FILE (37)"
 123 A file given with FILE:// couldn't be opened. Most likely because the file
 124 path doesn't identify an existing file. Did you check file permissions?
 125 .IP "CURLE_LDAP_CANNOT_BIND (38)"
 126 LDAP cannot bind. LDAP bind operation failed.
 127 .IP "CURLE_LDAP_SEARCH_FAILED (39)"
 128 LDAP search failed.
 129 .IP "CURLE_LIBRARY_NOT_FOUND (40)"
 130 Library not found. The LDAP library was not found.
 131 .IP "CURLE_FUNCTION_NOT_FOUND (41)"
 132 Function not found. A required LDAP function was not found.
 133 .IP "CURLE_ABORTED_BY_CALLBACK (42)"
 134 Aborted by callback. A callback returned "abort" to libcurl.
 135 .IP "CURLE_BAD_FUNCTION_ARGUMENT (43)"
 136 Internal error. A function was called with a bad parameter.
 137 .IP "CURLE_BAD_CALLING_ORDER (44)"
 138 Internal error. A function was called in a bad order.
 139 .IP "CURLE_HTTP_PORT_FAILED (45)"
 140 Interface error. A specified outgoing interface could not be used. Set which
 141 interface to use for outgoing connections' source IP address with
 142 CURLOPT_INTERFACE.
 143 .IP "CURLE_BAD_PASSWORD_ENTERED (46)"
 144 Bad password entered. An error was signaled when the password was
 145 entered. This can also be the result of a "bad password" returned from a
 146 specified password callback.
 147 .IP "CURLE_TOO_MANY_REDIRECTS (47)"
 148 Too many redirects. When following redirects, libcurl hit the maximum amount.
 149 Set your limit with CURLOPT_MAXREDIRS.
 150 .IP "CURLE_UNKNOWN_TELNET_OPTION (48)"
 151 An option set with CURLOPT_TELNETOPTIONS was not recognized/known. Refer to
 152 the appropriate documentation.
 153 .IP "CURLE_TELNET_OPTION_SYNTAX (49)"
 154 A telnet option string was Illegally formatted.
 155 .IP "CURLE_OBSOLETE (50)"
 156 This is not an error. This used to be another error code in an old libcurl
 157 version and is currently unused.
 158 .IP "CURLE_SSL_PEER_CERTIFICATE (51)"
 159 The remote server's SSL certificate was deemed not OK.
 160 .IP "CURLE_GOT_NOTHING (52)"
 161 Nothing was returned from the server, and under the circumstances, getting
 162 nothing is considered an error.
 163 .IP "CURLE_SSL_ENGINE_NOTFOUND (53)"
 164 The specified crypto engine wasn't found.
 165 .IP "CURLE_SSL_ENGINE_SETFAILED (54)"
 166 Failed setting the selected SSL crypto engine as default!
 167 .IP "CURLE_SEND_ERROR (55)"
 168 Failed sending network data.
 169 .IP "CURLE_RECV_ERROR (56)"
 170 Failure with receiving network data.
 171 .IP "CURLE_RECV_ERROR (57)"
 172 Failure with receiving network data.
 173 .IP "CURLE_SSL_CERTPROBLEM (58)"
 174 problem with the local certificate
 175 .IP "CURLE_SSL_CIPHER (59)"
 176 couldn't use specified cipher
 177 .IP "CURLE_SSL_CACERT (60)"
 178 problem with the CA cert (path? access rights?)
 179 .IP "CURLE_BAD_CONTENT_ENCODING (61)"
 180 Unrecognized transfer encoding
 181 .IP "CURLE_LDAP_INVALID_URL (62)"
 182 Invalid LDAP URL
 183 .IP "CURLE_FILESIZE_EXCEEDED (63)"
 184 Maximum file size exceeded
 185 .IP "CURLE_FTP_SSL_FAILED (64)"
 186 Requested FTP SSL level failed
 187 .SH "CURLMcode"
 188 This is the generic return code used by functions in the libcurl multi
 189 interface.
 190
 191 This is left to be documented.
 192 .SH "CURLSHcode"
 193 The "share" interface will return a CURLSHcode to indicate when an
 194 error has occurred.
 195
 196 CURLSHcode is one of the following:
 197 .IP "CURLSHE_OK (0)"
 198 All fine. Proceed as usual.
 199 .IP "CURLSHE_BAD_OPTION (1)"
 200 An invalid option was passed to the function.
 201 .IP "CURLSHE_IN_USE (2)"
 202 The share object is currently in use.
 203 .IP "CURLSHE_INVALID (3)"
 204 An invalid share object was passed to the function.
 205