← Back to branch summary

~ubuntu-branches/ubuntu/dapper/curl/dapper-security

« back to all changes in this revision

Viewing changes to docs/libcurl/curl_easy_getinfo.3

  • Committer: Bazaar Package Importer
  • Author(s): LaMont Jones
  • Date: 2005-03-23 18:41:29 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20050323184129-le70d05a0hk5w62j
Tags: 7.12.3-2ubuntu3
Fix the version numbers internal to debian/rules.  Closes; #8088

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libcurl/curl_easy_getinfo.3
1
1
.\" You can view this file with:
2
2
.\" nroff -man [file]
3
 
.\" $Id: curl_easy_getinfo.3,v 1.11 2004/03/24 21:40:45 bagder Exp $
 
3
.\" $Id: curl_easy_getinfo.3,v 1.17 2004/12/14 22:47:13 bagder Exp $
4
4
.\"
5
 
.TH curl_easy_getinfo 3 "20 Aug 2003" "libcurl 7.10.8" "libcurl Manual"
 
5
.TH curl_easy_getinfo 3 "14 Dec 2004" "libcurl 7.12.3" "libcurl Manual"
6
6
.SH NAME
7
7
curl_easy_getinfo - extract information from a curl handle
8
8
.SH SYNOPSIS
12
12
 
13
13
.SH DESCRIPTION
14
14
Request internal information from the curl session with this function.  The
15
 
third argument
16
 
.B MUST
17
 
be a pointer to a long, a pointer to a char * or a pointer to a double (as
18
 
this documentation describes further down).  The data pointed-to will be
19
 
filled in accordingly and can be relied upon only if the function returns
20
 
CURLE_OK.  This function is intended to get used *AFTER* a performed transfer,
21
 
all results from this function are undefined until the transfer is completed.
 
15
third argument \fBMUST\fP be a pointer to a long, a pointer to a char *, a
 
16
pointer to a struct curl_slist * or a pointer to a double (as this
 
17
documentation describes further down).  The data pointed-to will be filled in
 
18
accordingly and can be relied upon only if the function returns CURLE_OK.
 
19
This function is intended to get used AFTER a performed transfer, all results
 
20
from this function are undefined until the transfer is completed.
 
21
 
 
22
You should not free the memory returned by this function unless it is
 
23
explictly mentioned below.
22
24
.SH AVAILABLE INFORMATION
23
25
The following information can be extracted:
24
26
.IP CURLINFO_EFFECTIVE_URL
86
88
Pass a pointer to a long to receive the result of the certification
87
89
verification that was requested (using the CURLOPT_SSL_VERIFYPEER option to
88
90
\fIcurl_easy_setopt(3)\fP).
 
91
.IP CURLINFO_SSL_ENGINES
 
92
Pass the address of a 'struct curl_slist *' to receive a linked-list of
 
93
OpenSSL crypto-engines supported. Note that engines are normally implemented
 
94
in separate dynamic libraries. Hence not all the returned engines may be
 
95
available at run-time. \fBNOTE:\fP you must call \fIcurl_slist_free_all(3)\fP
 
96
on the list pointer once you're done with it, as libcurl will not free the
 
97
data for you. (Added in 7.12.3)
89
98
.IP CURLINFO_CONTENT_LENGTH_DOWNLOAD
90
99
Pass a pointer to a double to receive the content-length of the download. This
91
100
is the value read from the Content-Length: field.
107
116
.IP CURLINFO_PROXYAUTH_AVAIL
108
117
Pass a pointer to a long to receive a bitmask indicating the authentication
109
118
method(s) available for your proxy authentication.  (Added in 7.10.8)
 
119
.IP CURLINFO_OS_ERRNO
 
120
Pass a pointer to a long to receive the errno variable from a connect failure.
 
121
(Added in 7.12.2)
 
122
.IP CURLINFO_NUM_CONNECTS
 
123
Pass a pointer to a long to receive how many new connections libcurl had to
 
124
create to achieve the previous transfer (only the successful connects are
 
125
counted).  Combined with \fICURLINFO_REDIRECT_COUNT\fP you are able to know
 
126
how many times libcurl successfully reused existing connection(s) or not.  See
 
127
the Connection Options of \fIcurl_easy_setopt(3)\fP to see how libcurl tries
 
128
to make persistent connections to save time.  (Added in 7.12.3)
110
129
.SH RETURN VALUE
111
130
If the operation was successful, CURLE_OK is returned. Otherwise an
112
131
appropriate error code will be returned.