2002-03-04 05:09:48 -05:00
|
|
|
.\" You can view this file with:
|
|
|
|
.\" nroff -man [file]
|
|
|
|
.\" $Id$
|
|
|
|
.\"
|
2004-12-22 07:31:55 -05:00
|
|
|
.TH curl_easy_getinfo 3 "22 Dec 2004" "libcurl 7.12.3" "libcurl Manual"
|
2002-03-04 05:09:48 -05:00
|
|
|
.SH NAME
|
2003-11-04 08:27:28 -05:00
|
|
|
curl_easy_getinfo - extract information from a curl handle
|
2002-03-04 05:09:48 -05:00
|
|
|
.SH SYNOPSIS
|
|
|
|
.B #include <curl/curl.h>
|
2003-11-04 08:27:28 -05:00
|
|
|
|
|
|
|
.B "CURLcode curl_easy_getinfo(CURL *curl, CURLINFO info, ... );"
|
|
|
|
|
2002-03-04 05:09:48 -05:00
|
|
|
.SH DESCRIPTION
|
|
|
|
Request internal information from the curl session with this function. The
|
2004-12-14 17:47:13 -05:00
|
|
|
third argument \fBMUST\fP be a pointer to a long, a pointer to a char *, a
|
|
|
|
pointer to a struct curl_slist * or a pointer to a double (as this
|
|
|
|
documentation describes further down). The data pointed-to will be filled in
|
|
|
|
accordingly and can be relied upon only if the function returns CURLE_OK.
|
|
|
|
This function is intended to get used AFTER a performed transfer, all results
|
|
|
|
from this function are undefined until the transfer is completed.
|
2004-08-24 16:36:38 -04:00
|
|
|
|
|
|
|
You should not free the memory returned by this function unless it is
|
|
|
|
explictly mentioned below.
|
2002-03-04 05:09:48 -05:00
|
|
|
.SH AVAILABLE INFORMATION
|
2004-03-24 16:40:45 -05:00
|
|
|
The following information can be extracted:
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_EFFECTIVE_URL
|
2002-03-04 05:09:48 -05:00
|
|
|
Pass a pointer to a 'char *' to receive the last used effective URL.
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_RESPONSE_CODE
|
2003-08-20 11:44:03 -04:00
|
|
|
Pass a pointer to a long to receive the last received HTTP or FTP code. This
|
2004-12-22 07:31:55 -05:00
|
|
|
option was known as CURLINFO_HTTP_CODE in libcurl 7.10.7 and earlier. This
|
|
|
|
will be zero if no server response code has been received. Note that a proxy's
|
|
|
|
CONNECT response should be read with \fICURLINFO_HTTP_CONNECTCODE\fP and not
|
|
|
|
this.
|
|
|
|
.IP CURLINFO_HTTP_CONNECTCODE
|
|
|
|
Pass a pointer to a long to receive the last received proxy response code to a
|
|
|
|
CONNECT request.
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_FILETIME
|
2005-06-11 18:04:41 -04:00
|
|
|
Pass a pointer to a long to receive the remote time of the retrieved document
|
|
|
|
(in number of seconds since 1 jan 1970 in the GMT/UTC time zone). If you get
|
|
|
|
-1, it can be because of many reasons (unknown, the server hides it or the
|
|
|
|
server doesn't support the command that tells document time etc) and the time
|
|
|
|
of the document is unknown. Note that you must tell the server to collect this
|
|
|
|
information before the transfer is made, by using the CURLOPT_FILETIME option
|
|
|
|
to \fIcurl_easy_setopt(3)\fP or you will unconditionally get a -1 back. (Added
|
|
|
|
in 7.5)
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_TOTAL_TIME
|
2002-03-04 05:09:48 -05:00
|
|
|
Pass a pointer to a double to receive the total transaction time in seconds
|
2002-04-25 12:45:15 -04:00
|
|
|
for the previous transfer. This time does not include the connect time, so if
|
|
|
|
you want the complete operation time, you should add the
|
|
|
|
CURLINFO_CONNECT_TIME.
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_NAMELOOKUP_TIME
|
2002-03-04 05:09:48 -05:00
|
|
|
Pass a pointer to a double to receive the time, in seconds, it took from the
|
|
|
|
start until the name resolving was completed.
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_CONNECT_TIME
|
2002-03-04 05:09:48 -05:00
|
|
|
Pass a pointer to a double to receive the time, in seconds, it took from the
|
|
|
|
start until the connect to the remote host (or proxy) was completed.
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_PRETRANSFER_TIME
|
2002-03-04 05:09:48 -05:00
|
|
|
Pass a pointer to a double to receive the time, in seconds, it took from the
|
|
|
|
start until the file transfer is just about to begin. This includes all
|
|
|
|
pre-transfer commands and negotiations that are specific to the particular
|
|
|
|
protocol(s) involved.
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_STARTTRANSFER_TIME
|
2002-03-04 05:09:48 -05:00
|
|
|
Pass a pointer to a double to receive the time, in seconds, it took from the
|
2004-03-24 16:40:45 -05:00
|
|
|
start until the first byte is just about to be transferred. This includes
|
2002-03-04 05:09:48 -05:00
|
|
|
CURLINFO_PRETRANSFER_TIME and also the time the server needs to calculate
|
|
|
|
the result.
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_REDIRECT_TIME
|
2002-04-17 03:21:17 -04:00
|
|
|
Pass a pointer to a double to receive the total time, in seconds, it took for
|
|
|
|
all redirection steps include name lookup, connect, pretransfer and transfer
|
|
|
|
before final transaction was started. CURLINFO_REDIRECT_TIME contains the
|
|
|
|
complete execution time for multiple redirections. (Added in 7.9.7)
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_REDIRECT_COUNT
|
2002-04-17 03:21:17 -04:00
|
|
|
Pass a pointer to a long to receive the total number of redirections that were
|
|
|
|
actually followed. (Added in 7.9.7)
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_SIZE_UPLOAD
|
2002-03-04 05:09:48 -05:00
|
|
|
Pass a pointer to a double to receive the total amount of bytes that were
|
|
|
|
uploaded.
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_SIZE_DOWNLOAD
|
2002-03-04 05:09:48 -05:00
|
|
|
Pass a pointer to a double to receive the total amount of bytes that were
|
2003-04-11 12:52:30 -04:00
|
|
|
downloaded. The amount is only for the latest transfer and will be reset again
|
|
|
|
for each new transfer.
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_SPEED_DOWNLOAD
|
2002-03-04 05:09:48 -05:00
|
|
|
Pass a pointer to a double to receive the average download speed that curl
|
|
|
|
measured for the complete download.
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_SPEED_UPLOAD
|
2002-03-04 05:09:48 -05:00
|
|
|
Pass a pointer to a double to receive the average upload speed that curl
|
|
|
|
measured for the complete upload.
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_HEADER_SIZE
|
2002-03-04 05:09:48 -05:00
|
|
|
Pass a pointer to a long to receive the total size of all the headers
|
|
|
|
received.
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_REQUEST_SIZE
|
2002-03-04 05:09:48 -05:00
|
|
|
Pass a pointer to a long to receive the total size of the issued
|
|
|
|
requests. This is so far only for HTTP requests. Note that this may be more
|
|
|
|
than one request if FOLLOWLOCATION is true.
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_SSL_VERIFYRESULT
|
2002-03-04 05:09:48 -05:00
|
|
|
Pass a pointer to a long to receive the result of the certification
|
|
|
|
verification that was requested (using the CURLOPT_SSL_VERIFYPEER option to
|
2004-02-27 10:34:06 -05:00
|
|
|
\fIcurl_easy_setopt(3)\fP).
|
2004-12-13 15:14:04 -05:00
|
|
|
.IP CURLINFO_SSL_ENGINES
|
|
|
|
Pass the address of a 'struct curl_slist *' to receive a linked-list of
|
|
|
|
OpenSSL crypto-engines supported. Note that engines are normally implemented
|
|
|
|
in separate dynamic libraries. Hence not all the returned engines may be
|
2004-12-14 17:47:13 -05:00
|
|
|
available at run-time. \fBNOTE:\fP you must call \fIcurl_slist_free_all(3)\fP
|
|
|
|
on the list pointer once you're done with it, as libcurl will not free the
|
|
|
|
data for you. (Added in 7.12.3)
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_CONTENT_LENGTH_DOWNLOAD
|
2002-03-04 05:09:48 -05:00
|
|
|
Pass a pointer to a double to receive the content-length of the download. This
|
2004-02-27 10:34:06 -05:00
|
|
|
is the value read from the Content-Length: field.
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_CONTENT_LENGTH_UPLOAD
|
2002-03-04 05:09:48 -05:00
|
|
|
Pass a pointer to a double to receive the specified size of the upload.
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_CONTENT_TYPE
|
2002-03-04 05:09:48 -05:00
|
|
|
Pass a pointer to a 'char *' to receive the content-type of the downloaded
|
|
|
|
object. This is the value read from the Content-Type: field. If you get NULL,
|
|
|
|
it means that the server didn't send a valid Content-Type header or that the
|
2004-02-27 10:34:06 -05:00
|
|
|
protocol used doesn't support this.
|
2003-11-04 08:27:28 -05:00
|
|
|
.IP CURLINFO_PRIVATE
|
2002-11-20 14:11:22 -05:00
|
|
|
Pass a pointer to a 'char *' to receive the pointer to the private data
|
2003-11-04 08:27:28 -05:00
|
|
|
associated with the curl handle (set with the CURLOPT_PRIVATE option to
|
2004-02-27 10:34:06 -05:00
|
|
|
\fIcurl_easy_setopt(3)\fP). (Added in 7.10.3)
|
2003-12-18 08:33:14 -05:00
|
|
|
.IP CURLINFO_HTTPAUTH_AVAIL
|
|
|
|
Pass a pointer to a long to receive a bitmask indicating the authentication
|
|
|
|
method(s) available. The meaning of the bits is explained in the
|
2004-02-27 10:34:06 -05:00
|
|
|
CURLOPT_HTTPAUTH option for \fIcurl_easy_setopt(3)\fP. (Added in 7.10.8)
|
2003-12-18 08:33:14 -05:00
|
|
|
.IP CURLINFO_PROXYAUTH_AVAIL
|
|
|
|
Pass a pointer to a long to receive a bitmask indicating the authentication
|
2004-03-24 16:40:45 -05:00
|
|
|
method(s) available for your proxy authentication. (Added in 7.10.8)
|
2004-09-30 17:01:23 -04:00
|
|
|
.IP CURLINFO_OS_ERRNO
|
|
|
|
Pass a pointer to a long to receive the errno variable from a connect failure.
|
2004-10-01 02:43:48 -04:00
|
|
|
(Added in 7.12.2)
|
2004-10-19 11:30:08 -04:00
|
|
|
.IP CURLINFO_NUM_CONNECTS
|
|
|
|
Pass a pointer to a long to receive how many new connections libcurl had to
|
|
|
|
create to achieve the previous transfer (only the successful connects are
|
|
|
|
counted). Combined with \fICURLINFO_REDIRECT_COUNT\fP you are able to know
|
|
|
|
how many times libcurl successfully reused existing connection(s) or not. See
|
|
|
|
the Connection Options of \fIcurl_easy_setopt(3)\fP to see how libcurl tries
|
|
|
|
to make persistent connections to save time. (Added in 7.12.3)
|
2005-07-27 18:17:14 -04:00
|
|
|
.IP CURLINFO_COOKIELIST
|
|
|
|
Pass a pointer to a 'struct curl_slist *' to receive a linked-list of all
|
|
|
|
cookies cURL knows (expired ones, too). Don't forget to
|
|
|
|
\fIcurl_slist_free_all(3)\fP the list after it has been used.
|
|
|
|
If there are no cookies (cookies for the handle have not been enabled or
|
|
|
|
simply none have been received) 'struct curl_slist *' will be set to
|
|
|
|
point to NULL.
|
2002-03-04 05:09:48 -05:00
|
|
|
.SH RETURN VALUE
|
|
|
|
If the operation was successful, CURLE_OK is returned. Otherwise an
|
|
|
|
appropriate error code will be returned.
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR curl_easy_setopt "(3)"
|