Return to CURLINFO_FTP_ENTRY_PATH.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_FTP_ENTRY_PATH.3, revision 1.1

1.1     ! misho       1: .\" **************************************************************************
        !             2: .\" *                                  _   _ ____  _
        !             3: .\" *  Project                     ___| | | |  _ \| |
        !             4: .\" *                             / __| | | | |_) | |
        !             5: .\" *                            | (__| |_| |  _ <| |___
        !             6: .\" *                             \___|\___/|_| \_\_____|
        !             7: .\" *
        !             8: .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
        !             9: .\" *
        !            10: .\" * This software is licensed as described in the file COPYING, which
        !            11: .\" * you should have received as part of this distribution. The terms
        !            12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
        !            13: .\" *
        !            14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
        !            15: .\" * copies of the Software, and permit persons to whom the Software is
        !            16: .\" * furnished to do so, under the terms of the COPYING file.
        !            17: .\" *
        !            18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
        !            19: .\" * KIND, either express or implied.
        !            20: .\" *
        !            21: .\" **************************************************************************
        !            22: .\"
        !            23: .TH CURLINFO_FTP_ENTRY_PATH 3 "May 06, 2017" "libcurl 7.70.0" "curl_easy_getinfo options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLINFO_FTP_ENTRY_PATH \- get entry path in FTP server
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_FTP_ENTRY_PATH, char **path);
        !            31: .SH DESCRIPTION
        !            32: Pass a pointer to a char pointer to receive a pointer to a string holding the
        !            33: path of the entry path. That is the initial path libcurl ended up in when
        !            34: logging on to the remote FTP server. This stores a NULL as pointer if
        !            35: something is wrong.
        !            36: 
        !            37: The \fBpath\fP pointer will be NULL or pointing to private memory you MUST NOT
        !            38: free - it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the
        !            39: corresponding CURL handle.
        !            40: .SH PROTOCOLS
        !            41: FTP(S) and SFTP
        !            42: .SH EXAMPLE
        !            43: .nf
        !            44: CURL *curl = curl_easy_init();
        !            45: if(curl) {
        !            46:   curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com");
        !            47: 
        !            48:   res = curl_easy_perform(curl);
        !            49: 
        !            50:   if(!res) {
        !            51:     /* extract the entry path */
        !            52:     char *ep = NULL;
        !            53:     res = curl_easy_getinfo(curl, CURLINFO_FTP_ENTRY_PATH, &ep);
        !            54:     if(!res && ep) {
        !            55:       printf("Entry path was: %s\\n", ep);
        !            56:     }
        !            57:   }
        !            58:   curl_easy_cleanup(curl);
        !            59: }
        !            60: .fi
        !            61: .SH AVAILABILITY
        !            62: Added in 7.15.4. Works for SFTP since 7.21.4
        !            63: .SH RETURN VALUE
        !            64: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
        !            65: .SH "SEE ALSO"
        !            66: .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "