| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253 |
- .\" generated by cd2nroff 0.1 from CURLINFO_FTP_ENTRY_PATH.md
- .TH CURLINFO_FTP_ENTRY_PATH 3 "2025-01-17" libcurl
- .SH NAME
- CURLINFO_FTP_ENTRY_PATH \- get entry path in FTP server
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_FTP_ENTRY_PATH, char **path);
- .fi
- .SH 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 server. This stores a NULL as pointer if
- something is wrong.
- The \fBpath\fP pointer is NULL or points to private memory. You MUST NOT free
- - it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the corresponding
- CURL handle.
- .SH PROTOCOLS
- This functionality affects ftp only
- .SH EXAMPLE
- .nf
- 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);
- }
- }
- .fi
- .SH HISTORY
- Works for SFTP since 7.21.4
- .SH AVAILABILITY
- Added in curl 7.15.4
- .SH RETURN VALUE
- Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- .SH SEE ALSO
- .BR curl_easy_getinfo (3),
- .BR curl_easy_setopt (3)
|