File size: 11,059 Bytes
25d264e |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 |
---
c: Copyright (C) Daniel Stenberg, <[email protected]>, et al.
SPDX-License-Identifier: curl
Title: curl_easy_getinfo
Section: 3
Source: libcurl
See-also:
- curl_easy_setopt (3)
Protocol:
- All
Added-in: 7.4.1
---
# NAME
curl_easy_getinfo - extract information from a curl handle
# SYNOPSIS
~~~c
#include <curl/curl.h>
CURLcode curl_easy_getinfo(CURL *curl, CURLINFO info, ... );
~~~
# DESCRIPTION
Get the *info* kept in the *curl* handle. The third argument **MUST** be
pointing to the specific type of the used option which is documented in each
man page of the *info* option. The data is stored accordingly and can be
relied upon only if this function returns CURLE_OK. Use this function after a
performed transfer if you want to get transfer related data.
You should not free the memory returned by this function unless it is
explicitly mentioned below.
# OPTIONS
The following information can be extracted:
## CURLINFO_ACTIVESOCKET
The session's active socket. See CURLINFO_ACTIVESOCKET(3)
## CURLINFO_APPCONNECT_TIME
The time it took from the start until the SSL connect/handshake with the
remote host was completed as a double in number of seconds. (Added in 7.19.0)
## CURLINFO_APPCONNECT_TIME_T
The time it took from the start until the SSL connect/handshake with the
remote host was completed in number of microseconds. (Added in 7.60.0) See
CURLINFO_APPCONNECT_TIME_T(3)
## CURLINFO_CAINFO
Get the default value for CURLOPT_CAINFO(3). See CURLINFO_CAINFO(3)
## CURLINFO_CAPATH
Get the default value for CURLOPT_CAPATH(3). See CURLINFO_CAPATH(3)
## CURLINFO_CERTINFO
Certificate chain. See CURLINFO_CERTINFO(3)
## CURLINFO_CONDITION_UNMET
Whether or not a time conditional was met or 304 HTTP response.
See CURLINFO_CONDITION_UNMET(3)
## CURLINFO_CONNECT_TIME
The time it took from the start until the connect to the remote host (or
proxy) was completed. As a double. See CURLINFO_CONNECT_TIME(3)
## CURLINFO_CONNECT_TIME_T
The time it took from the start until the connect to the remote host (or
proxy) was completed. In microseconds. See CURLINFO_CONNECT_TIME_T(3).
## CURLINFO_CONN_ID
The ID of the last connection used by the transfer. (Added in 8.2.0)
See CURLINFO_CONN_ID(3)
## CURLINFO_CONTENT_LENGTH_DOWNLOAD
(**Deprecated**) Content length from the Content-Length header.
See CURLINFO_CONTENT_LENGTH_DOWNLOAD(3)
## CURLINFO_CONTENT_LENGTH_DOWNLOAD_T
Content length from the Content-Length header.
See CURLINFO_CONTENT_LENGTH_DOWNLOAD_T(3)
## CURLINFO_CONTENT_LENGTH_UPLOAD
(**Deprecated**) Upload size. See CURLINFO_CONTENT_LENGTH_UPLOAD(3)
## CURLINFO_CONTENT_LENGTH_UPLOAD_T
Upload size. See CURLINFO_CONTENT_LENGTH_UPLOAD_T(3)
## CURLINFO_CONTENT_TYPE
Content type from the `Content-Type:` header. We recommend using
curl_easy_header(3) instead. See CURLINFO_CONTENT_TYPE(3)
## CURLINFO_COOKIELIST
List of all known cookies. See CURLINFO_COOKIELIST(3)
## CURLINFO_EARLYDATA_SENT_T
Amount of TLS early data sent (in number of bytes) when
CURLSSLOPT_EARLYDATA is enabled.
## CURLINFO_EFFECTIVE_METHOD
Last used HTTP method. See CURLINFO_EFFECTIVE_METHOD(3)
## CURLINFO_EFFECTIVE_URL
Last used URL. See CURLINFO_EFFECTIVE_URL(3)
## CURLINFO_FILETIME
Remote time of the retrieved document. See CURLINFO_FILETIME(3)
## CURLINFO_FILETIME_T
Remote time of the retrieved document. See CURLINFO_FILETIME_T(3)
## CURLINFO_FTP_ENTRY_PATH
The entry path after logging in to an FTP server. See
CURLINFO_FTP_ENTRY_PATH(3)
## CURLINFO_HEADER_SIZE
Number of bytes of all headers received. See CURLINFO_HEADER_SIZE(3)
## CURLINFO_HTTPAUTH_AVAIL
Available HTTP authentication methods. See CURLINFO_HTTPAUTH_AVAIL(3)
## CURLINFO_HTTP_CONNECTCODE
Last proxy CONNECT response code. See CURLINFO_HTTP_CONNECTCODE(3)
## CURLINFO_HTTP_VERSION
The http version used in the connection. See CURLINFO_HTTP_VERSION(3)
## CURLINFO_LASTSOCKET
(**Deprecated**) Last socket used. See CURLINFO_LASTSOCKET(3)
## CURLINFO_LOCAL_IP
Source IP address of the last connection. See CURLINFO_LOCAL_IP(3)
## CURLINFO_LOCAL_PORT
Source port number of the last connection. See CURLINFO_LOCAL_PORT(3)
## CURLINFO_NAMELOOKUP_TIME
Time from start until name resolving completed as a double. See
CURLINFO_NAMELOOKUP_TIME(3)
## CURLINFO_NAMELOOKUP_TIME_T
Time from start until name resolving completed in number of microseconds. See
CURLINFO_NAMELOOKUP_TIME_T(3)
## CURLINFO_NUM_CONNECTS
Number of new successful connections used for previous transfer.
See CURLINFO_NUM_CONNECTS(3)
## CURLINFO_OS_ERRNO
The errno from the last failure to connect. See CURLINFO_OS_ERRNO(3)
## CURLINFO_POSTTRANSFER_TIME_T
The time it took from the start until the last byte is sent by libcurl.
In microseconds. (Added in 8.10.0) See CURLINFO_POSTTRANSFER_TIME_T(3)
## CURLINFO_PRETRANSFER_TIME
The time 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. See
CURLINFO_PRETRANSFER_TIME(3)
## CURLINFO_PRETRANSFER_TIME_T
The time 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. In microseconds. See
CURLINFO_PRETRANSFER_TIME_T(3)
## CURLINFO_PRIMARY_IP
Destination IP address of the last connection. See CURLINFO_PRIMARY_IP(3)
## CURLINFO_PRIMARY_PORT
Destination port of the last connection. See CURLINFO_PRIMARY_PORT(3)
## CURLINFO_PRIVATE
User's private data pointer. See CURLINFO_PRIVATE(3)
## CURLINFO_PROTOCOL
(**Deprecated**) The protocol used for the connection. (Added in 7.52.0) See
CURLINFO_PROTOCOL(3)
## CURLINFO_PROXYAUTH_AVAIL
Available HTTP proxy authentication methods. See CURLINFO_PROXYAUTH_AVAIL(3)
## CURLINFO_PROXY_ERROR
Detailed proxy error. See CURLINFO_PROXY_ERROR(3)
## CURLINFO_PROXY_SSL_VERIFYRESULT
Proxy certificate verification result. See CURLINFO_PROXY_SSL_VERIFYRESULT(3)
## CURLINFO_QUEUE_TIME_T
The time during which the transfer was held in a waiting queue before it could
start for real in number of microseconds. (Added in 8.6.0) See
CURLINFO_QUEUE_TIME_T(3)
## CURLINFO_REDIRECT_COUNT
Total number of redirects that were followed. See CURLINFO_REDIRECT_COUNT(3)
## CURLINFO_REDIRECT_TIME
The time it took for all redirection steps include name lookup, connect,
pretransfer and transfer before final transaction was started. So, this is
zero if no redirection took place. As a double. See CURLINFO_REDIRECT_TIME(3)
## CURLINFO_REDIRECT_TIME_T
The time it took for all redirection steps include name lookup, connect,
pretransfer and transfer before final transaction was started. So, this is
zero if no redirection took place. In number of microseconds. See
CURLINFO_REDIRECT_TIME_T(3)
## CURLINFO_REDIRECT_URL
URL a redirect would take you to, had you enabled redirects. See
CURLINFO_REDIRECT_URL(3)
## CURLINFO_REFERER
Referrer header. See CURLINFO_REFERER(3)
## CURLINFO_REQUEST_SIZE
Number of bytes sent in the issued HTTP requests. See CURLINFO_REQUEST_SIZE(3)
## CURLINFO_RESPONSE_CODE
Last received response code. See CURLINFO_RESPONSE_CODE(3)
## CURLINFO_RETRY_AFTER
The value from the Retry-After header. See CURLINFO_RETRY_AFTER(3)
## CURLINFO_RTSP_CLIENT_CSEQ
The RTSP client CSeq that is expected next. See CURLINFO_RTSP_CLIENT_CSEQ(3)
## CURLINFO_RTSP_CSEQ_RECV
RTSP CSeq last received. See CURLINFO_RTSP_CSEQ_RECV(3)
## CURLINFO_RTSP_SERVER_CSEQ
The RTSP server CSeq that is expected next. See CURLINFO_RTSP_SERVER_CSEQ(3)
## CURLINFO_RTSP_SESSION_ID
RTSP session ID. See CURLINFO_RTSP_SESSION_ID(3)
## CURLINFO_SCHEME
The scheme used for the connection. (Added in 7.52.0) See CURLINFO_SCHEME(3)
## CURLINFO_SIZE_DOWNLOAD
(**Deprecated**) Number of bytes downloaded. See CURLINFO_SIZE_DOWNLOAD(3)
## CURLINFO_SIZE_DOWNLOAD_T
Number of bytes downloaded. See CURLINFO_SIZE_DOWNLOAD_T(3)
## CURLINFO_SIZE_UPLOAD
(**Deprecated**) Number of bytes uploaded. See CURLINFO_SIZE_UPLOAD(3)
## CURLINFO_SIZE_UPLOAD_T
Number of bytes uploaded. See CURLINFO_SIZE_UPLOAD_T(3)
## CURLINFO_SPEED_DOWNLOAD
(**Deprecated**) Average download speed. See CURLINFO_SPEED_DOWNLOAD(3)
## CURLINFO_SPEED_DOWNLOAD_T
Average download speed. See CURLINFO_SPEED_DOWNLOAD_T(3)
## CURLINFO_SPEED_UPLOAD
(**Deprecated**) Average upload speed. See CURLINFO_SPEED_UPLOAD(3)
## CURLINFO_SPEED_UPLOAD_T
Average upload speed in number of bytes per second. See
CURLINFO_SPEED_UPLOAD_T(3)
## CURLINFO_SSL_ENGINES
A list of OpenSSL crypto engines. See CURLINFO_SSL_ENGINES(3)
## CURLINFO_SSL_VERIFYRESULT
Certificate verification result. See CURLINFO_SSL_VERIFYRESULT(3)
## CURLINFO_STARTTRANSFER_TIME
The time it took from the start until the first byte is received by libcurl.
As a double. See CURLINFO_STARTTRANSFER_TIME(3)
## CURLINFO_STARTTRANSFER_TIME_T
The time it took from the start until the first byte is received by libcurl.
In microseconds. See CURLINFO_STARTTRANSFER_TIME_T(3)
## CURLINFO_TLS_SESSION
(**Deprecated**) TLS session info that can be used for further processing. See
CURLINFO_TLS_SESSION(3). Use CURLINFO_TLS_SSL_PTR(3) instead.
## CURLINFO_TLS_SSL_PTR
TLS session info that can be used for further processing. See
CURLINFO_TLS_SSL_PTR(3)
## CURLINFO_TOTAL_TIME
Total time of previous transfer. See CURLINFO_TOTAL_TIME(3)
## CURLINFO_TOTAL_TIME_T
Total time of previous transfer. See CURLINFO_TOTAL_TIME_T(3)
## CURLINFO_USED_PROXY
Whether the proxy was used (Added in 8.7.0). See CURLINFO_USED_PROXY(3)
## CURLINFO_XFER_ID
The ID of the transfer. (Added in 8.2.0) See CURLINFO_XFER_ID(3)
# TIMES
An overview of the time values available from curl_easy_getinfo(3)
curl_easy_perform()
|
|--QUEUE
|--|--NAMELOOKUP
|--|--|--CONNECT
|--|--|--|--APPCONNECT
|--|--|--|--|--PRETRANSFER
|--|--|--|--|--|--POSTTRANSFER
|--|--|--|--|--|--|--STARTTRANSFER
|--|--|--|--|--|--|--|--TOTAL
|--|--|--|--|--|--|--|--REDIRECT
CURLINFO_QUEUE_TIME_T(3), CURLINFO_NAMELOOKUP_TIME_T(3),
CURLINFO_CONNECT_TIME_T(3), CURLINFO_APPCONNECT_TIME_T(3),
CURLINFO_PRETRANSFER_TIME_T(3), CURLINFO_POSTTRANSFER_TIME_T(3),
CURLINFO_STARTTRANSFER_TIME_T(3), CURLINFO_TOTAL_TIME_T(3),
CURLINFO_REDIRECT_TIME_T(3)
# %PROTOCOLS%
# EXAMPLE
~~~c
int main(void)
{
CURL *curl = curl_easy_init();
if(curl) {
CURLcode res;
curl_easy_setopt(curl, CURLOPT_URL, "https://www.example.com/");
res = curl_easy_perform(curl);
if(CURLE_OK == res) {
char *ct;
/* ask for the content-type */
res = curl_easy_getinfo(curl, CURLINFO_CONTENT_TYPE, &ct);
if((CURLE_OK == res) && ct)
printf("We received Content-Type: %s\n", ct);
}
/* always cleanup */
curl_easy_cleanup(curl);
}
}
~~~
# %AVAILABILITY%
# RETURN VALUE
If the operation was successful, CURLE_OK is returned. Otherwise an
appropriate error code is returned.
|