mirror of
https://github.com/libssh2/libssh2.git
synced 2025-10-30 12:05:34 +03:00
592e2b37fa
- simplify `.TH` headers. - delete empty lines before sections. - update template with an `AVAILABILITY` section. Left libssh2 version number in the `.TH` header for entries without an `AVAILABILITY` section, or where there was a different version number there.
23 lines
739 B
Groff
23 lines
739 B
Groff
.TH libssh2_sftp_readlink 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
|
|
.SH NAME
|
|
libssh2_sftp_readlink - convenience macro for \fIlibssh2_sftp_symlink_ex(3)\fP
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
#include <libssh2_sftp.h>
|
|
|
|
#define libssh2_sftp_readlink(sftp, path, target, maxlen) \\
|
|
libssh2_sftp_symlink_ex((sftp), (path), strlen(path), \\
|
|
(target), (maxlen), \\
|
|
LIBSSH2_SFTP_READLINK)
|
|
.fi
|
|
.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)
|