← Back to branch summary

~ubuntu-branches/ubuntu/lucid/curl/lucid-201101212007

« back to all changes in this revision

Viewing changes to docs/libcurl/curl_easy_getinfo.3

  • Committer: Bazaar Package Importer
  • Author(s): Bhavani Shankar
  • Date: 2009-05-26 18:58:51 UTC
  • mfrom: (3.3.1 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090526185851-t1gun9nboi5kbd9u
Tags: 7.19.5-1ubuntu1
https://launchpad.net/bugs/380281
https://launchpad.net/bugs/379477
* Merge from Debian unstable (LP: #380281), remaining changes:
  - Drop build dependencies: stunnel, libdb4.6-dev, libssh2-1-dev
  - Add build-dependency on openssh-server
  - Drop libssh2-1-dev from libcurl4-openssl-dev's Depends.
  - Call automake-1.9 with --add-missing --copy --force
* Fixes LP: #379477

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libcurl/curl_easy_getinfo.3
18
18
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19
19
.\" * KIND, either express or implied.
20
20
.\" *
21
 
.\" * $Id: curl_easy_getinfo.3,v 1.40 2009-02-23 18:45:00 bagder Exp $
 
21
.\" * $Id: curl_easy_getinfo.3,v 1.42 2009-05-07 09:31:24 bagder Exp $
22
22
.\" **************************************************************************
23
23
.\"
24
24
.TH curl_easy_getinfo 3 "11 Feb 2009" "libcurl 7.19.4" "libcurl Manual"
43
43
.SH AVAILABLE INFORMATION
44
44
The following information can be extracted:
45
45
.IP CURLINFO_EFFECTIVE_URL
46
 
Pass a pointer to a 'char *' to receive the last used effective URL.
 
46
Pass a pointer to a char pointer to receive the last used effective URL.
47
47
.IP CURLINFO_RESPONSE_CODE
48
48
Pass a pointer to a long to receive the last received HTTP or FTP code. This
49
49
option was known as CURLINFO_HTTP_CODE in libcurl 7.10.7 and earlier. This
140
140
Pass a pointer to a double to receive the specified size of the upload.  Since
141
141
7.19.4, this returns -1 if the size isn't known.
142
142
.IP CURLINFO_CONTENT_TYPE
143
 
Pass a pointer to a 'char *' to receive the content-type of the downloaded
 
143
Pass a pointer to a char pointer to receive the content-type of the downloaded
144
144
object. This is the value read from the Content-Type: field. If you get NULL,
145
145
it means that the server didn't send a valid Content-Type header or that the
146
146
protocol used doesn't support this.
147
147
.IP CURLINFO_PRIVATE
148
 
Pass a pointer to a 'char *' to receive the pointer to the private data
 
148
Pass a pointer to a char pointer to receive the pointer to the private data
149
149
associated with the curl handle (set with the CURLOPT_PRIVATE option to
150
150
\fIcurl_easy_setopt(3)\fP). Please note that for internal reasons, the
151
 
value is returned as a 'char *', although effectively being a 'void *'.
 
151
value is returned as a char pointer, although effectively being a 'void *'.
152
152
(Added in 7.10.3)
153
153
.IP CURLINFO_HTTPAUTH_AVAIL
154
154
Pass a pointer to a long to receive a bitmask indicating the authentication
188
188
handle. This is typically used in combination with \fICURLOPT_CONNECT_ONLY\fP.
189
189
(Added in 7.15.2)
190
190
.IP CURLINFO_FTP_ENTRY_PATH
191
 
Pass a pointer to a 'char *' to receive a pointer to a string holding the path
192
 
of the entry path. That is the initial path libcurl ended up in when logging
193
 
on to the remote FTP server. This stores a NULL as pointer if something is
194
 
wrong. (Added in 7.15.4)
 
191
Pass a pointer to a char pointer to receive a pointer to a string holding the
 
192
path of the entry path. That is the initial path libcurl ended up in when
 
193
logging on to the remote FTP server. This stores a NULL as pointer if
 
194
something is wrong. (Added in 7.15.4)
195
195
.IP CURLINFO_CERTINFO
196
196
Pass a pointer to a 'struct curl_certinfo *' and you'll get it set to point to
197
197
struct that holds a number of linked lists with info about the certificate
209
209
because it didn't fulfill the condition. The long ths argument points to will
210
210
get a zero stored if the condition instead was met. (Added in 7.19.4)
211
211
.SH TIMES
212
 
.NF
 
212
.nf
213
213
An overview of the six time values available from curl_easy_getinfo()
214
214
 
215
215
curl_easy_perform()
221
221
    |--|--|--|--|--STARTTRANSFER
222
222
    |--|--|--|--|--|--TOTAL
223
223
    |--|--|--|--|--|--REDIRECT
224
 
.FI
 
224
.fi
225
225
.IP NAMELOOKUP
226
226
\fICURLINFO_NAMELOOKUP_TIME\fP. The time it took from the start until the name
227
227
resolving was completed.