Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_PROXY_TRANSFER_MODE (3)

Name

CURLOPT_PROXY_TRANSFER_MODE - append FTP transfer mode to URL for proxy

Synopsis

#include <curl/curl.h>

CURLcode  curl_easy_setopt(CURL  *handle,  CURLOPT_PROXY_TRANSFER_MODE,
long enabled);

Description

curl_easy_setopt options                        CURLOPT_PROXY_TRANSFER_MODE(3)



NAME
       CURLOPT_PROXY_TRANSFER_MODE - append FTP transfer mode to URL for proxy

SYNOPSIS
       #include <curl/curl.h>

       CURLcode  curl_easy_setopt(CURL  *handle,  CURLOPT_PROXY_TRANSFER_MODE,
       long enabled);

DESCRIPTION
       Pass a long. If the value is set to 1 (one), it tells  libcurl  to  set
       the  transfer mode (binary or ASCII) for FTP transfers done via an HTTP
       proxy, by appending ;type=a or ;type=i to the URL.  Without  this  set-
       ting, or it being set to 0 (zero, the default), CURLOPT_TRANSFERTEXT(3)
       has no effect when doing FTP via a proxy. Beware that not  all  proxies
       support this feature.

DEFAULT
       0, disabled

PROTOCOLS
       FTP over proxy

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/old-server/file.txt");
         curl_easy_setopt(curl, CURLOPT_PROXY, "http://localhost:80");
         curl_easy_setopt(curl, CURLOPT_PROXY_TRANSFER_MODE, 1L);
         curl_easy_setopt(curl, CURLOPT_TRANSFERTEXT, 1L);
         ret = curl_easy_perform(curl);
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.18.0

RETURN VALUE
       Returns  CURLE_OK  if the option is supported, and CURLE_UNKNOWN_OPTION
       if the enabled value is not supported.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_PROXY(3), CURLOPT_HTTPPROXYTUNNEL(3),



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    19 Jun 2014
                                                CURLOPT_PROXY_TRANSFER_MODE(3)