curl / libcurl / API / curl_easy_setopt / CURLOPT_PREQUOTE

CURLOPT_PREQUOTE explained

Name

CURLOPT_PREQUOTE - commands to run before an FTP transfer

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PREQUOTE,
                          struct curl_slist *cmds);

Description

Pass a pointer to a linked list of FTP commands to pass to the server after the transfer type is set. The linked list should be a fully valid list of struct curl_slist structs properly filled in as described for CURLOPT_QUOTE.

Using this option multiple times makes the last set string override the previous ones. Set it to NULL to disable its use again.

libcurl does not copy the list, it needs to be kept around until after the transfer has completed.

These commands are not performed when a directory listing is performed, only for file transfers.

While CURLOPT_QUOTE and CURLOPT_POSTQUOTE work for SFTP, this option does not.

Default

NULL

Protocols

This functionality affects ftp only

Example

int main(void)
{
  struct curl_slist *cmdlist = NULL;
  cmdlist = curl_slist_append(cmdlist, "SYST");
 
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/foo.bin");
 
    /* pass in the FTP commands to run */
    curl_easy_setopt(curl, CURLOPT_PREQUOTE, cmdlist);
 
    res = curl_easy_perform(curl);
 
    curl_easy_cleanup(curl);
  }
  curl_slist_free_all(cmdlist);
}

Availability

Added in curl 7.9.5

Return value

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.