Imported Upstream version 7.48.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLINFO_LASTSOCKET.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .\"
23 .TH CURLINFO_LASTSOCKET 3 "12 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
24 .SH NAME
25 CURLINFO_LASTSOCKET \- get the last socket used
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_LASTSOCKET, long *socket);
30 .SH DESCRIPTION
31 Deprecated since 7.45.0. Use \fICURLINFO_ACTIVESOCKET(3)\fP instead.
32
33 Pass a pointer to a long to receive the last socket used by this curl
34 session. If the socket is no longer valid, -1 is returned. When you finish
35 working with the socket, you must call curl_easy_cleanup() as usual and let
36 libcurl close the socket and cleanup other resources associated with the
37 handle. This is typically used in combination with
38 \fICURLOPT_CONNECT_ONLY(3)\fP.
39
40 NOTE: this API is deprecated since it is not working on win64 where the SOCKET
41 type is 64 bits large while its 'long' is 32 bits. Use the
42 \fICURLINFO_ACTIVESOCKET(3)\fP instead, if possible.
43 .SH PROTOCOLS
44 All
45 .SH EXAMPLE
46 TODO
47 .SH AVAILABILITY
48 Added in 7.15.2
49 .SH RETURN VALUE
50 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
51 .SH "SEE ALSO"
52 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
53 .BR CURLINFO_ACTIVESOCKET "(3), "