libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_sftp_open_r 3 "10 Apr 2023" "libssh2 1.11.0" "libssh2"
4
.SH NAME
5
libssh2_sftp_open_r - convenience macro for \fIlibssh2_sftp_open_ex_r(3)\fP calls
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9
#include <libssh2_sftp.h>
10

11
LIBSSH2_SFTP_HANDLE *
12
libssh2_sftp_open_r(LIBSSH2_SFTP *sftp, const char *filename,
13
                    unsigned long flags,
14
                    long mode,
15
                    LIBSSH2_SFTP_ATTRIBUTES *attrs);
16
.fi
17
.SH DESCRIPTION
18
This is a macro defined in a public libssh2 header file that is using the
19
underlying function \fIlibssh2_sftp_open_ex_r(3)\fP.
20
.SH RETURN VALUE
21
See \fIlibssh2_sftp_open_ex_r(3)\fP
22
.SH ERRORS
23
See \fIlibssh2_sftp_open_ex_r(3)\fP
24
.SH SEE ALSO
25
.BR libssh2_sftp_open_ex_r(3)
26