Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLINFO_FTP_ENTRY_PATH (3)

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

curl_easy_getinfo options                           CURLINFO_FTP_ENTRY_PATH(3)



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 hold-
       ing the path of the entry path. That is the initial path libcurl  ended
       up  in  when logging on to the remote FTP server. This stores a NULL as
       pointer if something is wrong.

       The path pointer will be NULL or pointing to private  memory  you  MUST
       NOT free - it gets freed when you call curl_easy_cleanup(3) on the cor-
       responding CURL handle.

PROTOCOLS
       FTP(S) and SFTP

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         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);
       }

AVAILABILITY
       Added in 7.15.4. Works for SFTP since 7.21.4

RETURN VALUE
       Returns CURLE_OK if the option 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
       curl_easy_getinfo(3), curl_easy_setopt(3),



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source       was       downloaded      from       https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

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



libcurl 7.83.1                 November 26, 2021
                                                    CURLINFO_FTP_ENTRY_PATH(3)