docs/libcurl/opts/CURLOPT_PROTOCOLS.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2  "http://www.w3.org/TR/html4/loose.dtd">
   3 <html><head>
   4 <title>CURLOPT_PROTOCOLS man page</title>
   5 <meta name="generator" content="roffit">
   6 <STYLE type="text/css">
   7 pre {
   8   overflow: auto;
   9   margin: 0;
  10 }
  11
  12 P.level0, pre.level0 {
  13  padding-left: 2em;
  14 }
  15
  16 P.level1, pre.level1 {
  17  padding-left: 4em;
  18 }
  19
  20 P.level2, pre.level2 {
  21  padding-left: 6em;
  22 }
  23
  24 span.emphasis {
  25  font-style: italic;
  26 }
  27
  28 span.bold {
  29  font-weight: bold;
  30 }
  31
  32 span.manpage {
  33  font-weight: bold;
  34 }
  35
  36 h2.nroffsh {
  37  background-color: #e0e0e0;
  38 }
  39
  40 span.nroffip {
  41  font-weight: bold;
  42  font-size: 120%;
  43  font-family: monospace;
  44 }
  45
  46 p.roffit {
  47  text-align: center;
  48  font-size: 80%;
  49 }
  50 </STYLE>
  51 </head><body>
  52
  53 <p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
  54 <p class="level0">CURLOPT_PROTOCOLS - set allowed protocols <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
  55 <p class="level0">&#35;include &lt;curl/curl.h&gt;
  56 <p class="level0">CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROTOCOLS, long bitmask); <a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
  57 <p class="level0">Pass a long that holds a bitmask of CURLPROTO_* defines. If used, this bitmask limits what protocols libcurl may use in the transfer. This allows you to have a libcurl built to support a wide range of protocols but still limit specific transfers to only be allowed to use a subset of them. By default libcurl will accept all protocols it supports (<span Class="emphasis">CURLPROTO_ALL</span>). See also <a Class="emphasis" href="./CURLOPT_REDIR_PROTOCOLS.html">CURLOPT_REDIR_PROTOCOLS</a>.
  58 <p class="level0">These are the available protocol defines: <pre class="level0">
  59 CURLPROTO_DICT
  60 CURLPROTO_FILE
  61 CURLPROTO_FTP
  62 CURLPROTO_FTPS
  63 CURLPROTO_GOPHER
  64 CURLPROTO_HTTP
  65 CURLPROTO_HTTPS
  66 CURLPROTO_IMAP
  67 CURLPROTO_IMAPS
  68 CURLPROTO_LDAP
  69 CURLPROTO_LDAPS
  70 CURLPROTO_POP3
  71 CURLPROTO_POP3S
  72 CURLPROTO_RTMP
  73 CURLPROTO_RTMPE
  74 CURLPROTO_RTMPS
  75 CURLPROTO_RTMPT
  76 CURLPROTO_RTMPTE
  77 CURLPROTO_RTMPTS
  78 CURLPROTO_RTSP
  79 CURLPROTO_SCP
  80 CURLPROTO_SFTP
  81 CURLPROTO_SMB
  82 CURLPROTO_SMTP
  83 CURLPROTO_SMTPS
  84 CURLPROTO_TELNET
  85 CURLPROTO_TFTP
  86 </pre>
  87
  88 <p class="level0"><a name="DEFAULT"></a><h2 class="nroffsh">DEFAULT</h2>
  89 <p class="level0">All protocols built-in <a name="PROTOCOLS"></a><h2 class="nroffsh">PROTOCOLS</h2>
  90 <p class="level0">All <a name="EXAMPLE"></a><h2 class="nroffsh">EXAMPLE</h2>
  91 <p class="level0"><pre class="level0">
  92 curl = curl_easy_init();
  93 if(curl) {
  94 &nbsp; /* pass in the URL from an external source */
  95 &nbsp; curl_easy_setopt(curl, CURLOPT_URL, argv[1]);
  96 &nbsp;
  97 &nbsp; /* only allow HTTP, TFTP and SFTP */
  98 &nbsp; curl_easy_setopt(curl, CURLOPT_PROTOCOLS,
  99 &nbsp;                  CURLPROTO_HTTP | CURLPROTO_TFTP | CURLPROTO_SFTP);
 100 &nbsp;
 101 &nbsp; /* Perform the request */
 102 &nbsp; curl_easy_perform(curl);
 103 }
 104 </pre>
 105
 106 <p class="level0"><a name="AVAILABILITY"></a><h2 class="nroffsh">AVAILABILITY</h2>
 107 <p class="level0">Added in 7.19.4 <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
 108 <p class="level0">Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
 109 <p class="level0"><a Class="manpage" href="./CURLOPT_REDIR_PROTOCOLS.html">CURLOPT_REDIR_PROTOCOLS</a>, <a Class="manpage" href="./CURLOPT_URL.html">CURLOPT_URL</a>, <span Class="manpage"> </span> <p class="roffit">
 110  This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
 111 </body></html>