docs/libcurl/opts/CURLINFO_FTP_ENTRY_PATH.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2015, 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 "12 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
  24 .SH NAME
  25 CURLINFO_FTP_ENTRY_PATH \- get entry path in FTP server
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_FTP_ENTRY_PATH, char **path);
  30 .SH DESCRIPTION
  31 Pass a pointer to a char pointer to receive a pointer to a string holding the
  32 path of the entry path. That is the initial path libcurl ended up in when
  33 logging on to the remote FTP server. This stores a NULL as pointer if
  34 something is wrong.
  35
  36 The \fBpath\fP pointer will be NULL or pointing to private memory you MUST NOT
  37 free - it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the
  38 corresponding CURL handle.
  39 .SH PROTOCOLS
  40 FTP(S) and SFTP
  41 .SH EXAMPLE
  42 TODO
  43 .SH AVAILABILITY
  44 Added in 7.15.4. Works for SFTP since 7.21.4
  45 .SH RETURN VALUE
  46 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  47 .SH "SEE ALSO"
  48 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "