Imported Upstream version 7.48.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLINFO_OS_ERRNO.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_OS_ERRNO 3 "1 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
24 .SH NAME
25 CURLINFO_OS_ERRNO \- get errno number from last connect failure
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_OS_ERRNO, long *errnop);
30 .SH DESCRIPTION
31 Pass a pointer to a long to receive the errno variable from a connect failure.
32 Note that the value is only set on failure, it is not reset upon a successful
33 operation. The number is OS and system specific.
34 .SH PROTOCOLS
35 All
36 .SH EXAMPLE
37 TODO
38 .SH AVAILABILITY
39 Added in 7.12.2
40 .SH RETURN VALUE
41 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
42 .SH "SEE ALSO"
43 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "