aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorAndreas Schneider <asn@cryptomilk.org>2019-02-27 08:32:10 +0100
committerAndreas Schneider <asn@cryptomilk.org>2019-02-27 08:32:10 +0100
commit7c444c09d7bdba1f0409ea8f874ccd283f2daa52 (patch)
tree111e882c2f0d34f9a5757088c395d9961a998078 /include
parent8234df5decfd924fb3ebdc5d75a5021491d8d26d (diff)
downloadlibssh-7c444c09d7bdba1f0409ea8f874ccd283f2daa52.tar.gz
libssh-7c444c09d7bdba1f0409ea8f874ccd283f2daa52.tar.xz
libssh-7c444c09d7bdba1f0409ea8f874ccd283f2daa52.zip
sftp: Document how to free memory retruned by sftp_canonicalize_path()
Fixes T129 Signed-off-by: Andreas Schneider <asn@cryptomilk.org>
Diffstat (limited to 'include')
-rw-r--r--include/libssh/sftp.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/include/libssh/sftp.h b/include/libssh/sftp.h
index 21512bce..3750e0c6 100644
--- a/include/libssh/sftp.h
+++ b/include/libssh/sftp.h
@@ -818,7 +818,9 @@ LIBSSH_API int sftp_fsync(sftp_file file);
*
* @param path The path to be canonicalized.
*
- * @return The canonicalize path, NULL on error.
+ * @return A pointer to the newly allocated canonicalized path,
+ * NULL on error. The caller needs to free the memory
+ * using ssh_string_free_char().
*/
LIBSSH_API char *sftp_canonicalize_path(sftp_session sftp, const char *path);