mirror of
https://github.com/libssh2/libssh2.git
synced 2025-11-03 22:13:11 +03:00
897f8463d8
The individual man pages for macros now show the full convenience macro as defined, and then the man page for the actual function only shows the function.
22 lines
733 B
Groff
22 lines
733 B
Groff
.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
|
|
.\"
|
|
.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 \fIlibssh2_sftp_symlink_ex(3)\fP
|