www.LinuxHowtos.org

CURLOPT_FTP_CREATE_MISSING_DIRS

Section: curl_easy_setopt options (3)
Updated: May 05, 2017
Index Return to Main Contents

NAME

CURLOPT_FTP_CREATE_MISSING_DIRS - create missing dirs for FTP and SFTP

SYNOPSIS

#include <curl/curl.h>

typedef enum {
  CURLFTP_CREATE_DIR_NONE,
  CURLFTP_CREATE_DIR,
  CURLFTP_CREATE_DIR_RETRY
} curl_ftpcreatedir;

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_CREATE_MISSING_DIRS,
                          long create);

DESCRIPTION

Pass a long telling libcurl to create the dir. If the value is CURLFTP_CREATE_DIR (1), libcurl will attempt to create any remote directory that it fails to "move" into.

For FTP requests, that means a CWD command fails. CWD being the command that changes working directory.

For SFTP requests, libcurl will attempt to create the remote directory if it can't obtain a handle to the target-location. The creation will fail if a file of the same name as the directory to create already exists or lack of permissions prevents creation.

Setting create to CURLFTP_CREATE_DIR_RETRY (2), tells libcurl to retry the CWD command again if the subsequent MKD command fails. This is especially useful if you're doing many simultaneous connections against the same server and they all have this option enabled, as then CWD may first fail but then another connection does MKD before this connection and thus MKD fails but trying CWD works!

DEFAULT

CURLFTP_CREATE_DIR_NONE (0)

PROTOCOLS

FTP and SFTP

EXAMPLE

CURL *curl = curl_easy_init();
if(curl) {
  curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/non-existing/new.txt");
  curl_easy_setopt(curl, CURLOPT_FTP_CREATE_MISSING_DIRS,
                         CURLFTP_CREATE_DIR_RETRY);

  ret = curl_easy_perform(curl);

  curl_easy_cleanup(curl);
}

AVAILABILITY

Added in 7.10.7. SFTP support added in 7.16.3. The retry option was added in 7.19.4.

RETURN VALUE

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