tizen 2.3.1 release
[external/curl.git] / docs / libcurl / opts / CURLOPT_ACCEPTTIMEOUT_MS.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2014, 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 http://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 CURLOPT_ACCEPTTIMEOUT_MS 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_ACCEPTTIMEOUT_MS \- timeout waiting for FTP server to connect back
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ACCEPTTIMEOUT_MS, long ms);
30 .SH DESCRIPTION
31 Pass a long telling libcurl the maximum number of milliseconds to wait for a
32 server to connect back to libcurl when an active FTP connection is used.
33 .SH DEFAULT
34 If no timeout is set, the internal default of 60000 (one minute) will be used.
35 .SH PROTOCOLS
36 FTP
37 .SH EXAMPLE
38 TODO
39 .SH AVAILABILITY
40 Added in 7.24.0
41 .SH RETURN VALUE
42 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
43 .SH "SEE ALSO"
44 .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "