mirror of
https://github.com/libssh2/libssh2.git
synced 2025-07-02 22:02:25 +03:00
- 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.
24 lines
722 B
Groff
24 lines
722 B
Groff
.TH libssh2_sftp_open_r 3 "10 Apr 2023" "libssh2 1.11.0" "libssh2"
|
|
.SH NAME
|
|
libssh2_sftp_open_r - convenience macro for \fIlibssh2_sftp_open_ex_r(3)\fP calls
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
#include <libssh2_sftp.h>
|
|
|
|
LIBSSH2_SFTP_HANDLE *
|
|
libssh2_sftp_open_r(LIBSSH2_SFTP *sftp, const char *filename,
|
|
unsigned long flags,
|
|
long mode,
|
|
LIBSSH2_SFTP_ATTRIBUTES *attrs);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
This is a macro defined in a public libssh2 header file that is using the
|
|
underlying function \fIlibssh2_sftp_open_ex_r(3)\fP.
|
|
.SH RETURN VALUE
|
|
See \fIlibssh2_sftp_open_ex_r(3)\fP
|
|
.SH ERRORS
|
|
See \fIlibssh2_sftp_open_ex_r(3)\fP
|
|
.SH SEE ALSO
|
|
.BR libssh2_sftp_open_ex_r(3)
|