Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_TRANSFERTEXT (3)

Name

CURLOPT_TRANSFERTEXT - request a text based transfer for FTP

Synopsis

#include <curl/curl.h>

CURLcode   curl_easy_setopt(CURL  *handle,  CURLOPT_TRANSFERTEXT,  long
text);

Description

CURLOPT_TRANSFERTEXT(3)    curl_easy_setopt options    CURLOPT_TRANSFERTEXT(3)



NAME
       CURLOPT_TRANSFERTEXT - request a text based transfer for FTP

SYNOPSIS
       #include <curl/curl.h>

       CURLcode   curl_easy_setopt(CURL  *handle,  CURLOPT_TRANSFERTEXT,  long
       text);

DESCRIPTION
       A parameter set to 1 tells the library to use ASCII mode for FTP trans-
       fers, instead of the default binary transfer. For win32 systems it does
       not set the stdout to binary mode.  This  option  can  be  usable  when
       transferring  text data between systems with different views on certain
       characters, such as newlines or similar.

       libcurl does not do a complete ASCII conversion when doing ASCII trans-
       fers  over  FTP. This is a known limitation/flaw that nobody has recti-
       fied. libcurl simply sets the mode to ASCII  and  performs  a  standard
       transfer.

DEFAULT
       0, disabled

PROTOCOLS
       FTP

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/textfile");
         curl_easy_setopt(curl, CURLOPT_TRANSFERTEXT, 1L);
         ret = curl_easy_perform(curl);
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Along with FTP

RETURN VALUE
       Returns CURLE_OK if FTP is supported, and CURLE_UNKNOWN_OPTION if not.


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_CRLF(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                    17 Jun 2014          CURLOPT_TRANSFERTEXT(3)