summaryrefslogtreecommitdiff
path: root/libssh2-sys/libssh2-1.4.4-20140901/docs/libssh2_sftp_readlink.3
blob: 7425074ecc07aad6e8439ad217837247ed34fee3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
.TH libssh2_sftp_readlink 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
.SH NAME
libssh2_sftp_readlink - convenience macro for \fIlibssh2_sftp_symlink_ex(3)\fP
.SH SYNOPSIS
.nf
#include <libssh2.h>

#define libssh2_sftp_readlink(sftp, path, target, maxlen) \\
    libssh2_sftp_symlink_ex((sftp), (path), strlen(path), (target), (maxlen), \\
    LIBSSH2_SFTP_READLINK)
.SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_sftp_symlink_ex(3)\fP.
.SH RETURN VALUE
See \fIlibssh2_sftp_symlink_ex(3)\fP
.SH ERRORS
See \fIlibssh2_sftp_symlink_ex(3)\fP
.SH SEE ALSO
.BR libssh2_sftp_symlink_ex(3)