1 .\" **************************************************************************
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
8 .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
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.
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.
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
21 .\" **************************************************************************
23 .TH CURLOPT_PROTOCOLS 3 "February 03, 2016" "libcurl 7.56.1" "curl_easy_setopt options"
26 CURLOPT_PROTOCOLS \- set allowed protocols
28 #include <curl/curl.h>
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROTOCOLS, long bitmask);
32 Pass a long that holds a bitmask of CURLPROTO_* defines. If used, this bitmask
33 limits what protocols libcurl may use in the transfer. This allows you to have
34 a libcurl built to support a wide range of protocols but still limit specific
35 transfers to only be allowed to use a subset of them. By default libcurl will
36 accept all protocols it supports (\fICURLPROTO_ALL\fP). See also
37 \fICURLOPT_REDIR_PROTOCOLS(3)\fP.
39 These are the available protocol defines:
71 All protocols built-in
76 curl = curl_easy_init();
78 /* pass in the URL from an external source */
79 curl_easy_setopt(curl, CURLOPT_URL, argv[1]);
81 /* only allow HTTP, TFTP and SFTP */
82 curl_easy_setopt(curl, CURLOPT_PROTOCOLS,
83 CURLPROTO_HTTP | CURLPROTO_TFTP | CURLPROTO_SFTP);
85 /* Perform the request */
86 curl_easy_perform(curl);
92 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
94 .BR CURLOPT_REDIR_PROTOCOLS "(3), " CURLOPT_URL "(3), "