curl / libcurl / API / curl_easy_getinfo / CURLINFO_FTP_ENTRY_PATH

CURLINFO_FTP_ENTRY_PATH explained

Name

CURLINFO_FTP_ENTRY_PATH - get entry path in FTP server

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_FTP_ENTRY_PATH, char **path);

Description

Pass a pointer to a char pointer to receive a pointer to a string holding the path of the entry path. That is the initial path libcurl ended up in when logging on to the remote FTP or SFTP server. This stores a NULL as pointer if something is wrong.

The path pointer is NULL or points to private memory. You must not free it. The memory gets freed automatically when you call curl_easy_cleanup on the corresponding curl handle.

Protocols

This functionality affects ftp and sftp

Example

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com");
 
    res = curl_easy_perform(curl);
 
    if(!res) {
      /* extract the entry path */
      char *ep = NULL;
      res = curl_easy_getinfo(curl, CURLINFO_FTP_ENTRY_PATH, &ep);
      if(!res && ep) {
        printf("Entry path was: %s\n", ep);
      }
    }
    curl_easy_cleanup(curl);
  }
}

History

Works for SFTP since 7.21.4

Availability

Added in curl 7.15.4

Return value

curl_easy_getinfo returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors.