libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_scp_recv 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_scp_recv - request a remote file via SCP
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
LIBSSH2_CHANNEL *
11
libssh2_scp_recv(LIBSSH2_SESSION *session, const char *path, struct stat *sb);
12
.fi
13
.SH DESCRIPTION
14
This function is \fBDEPRECATED\fP in 1.7.0. Use the
15
\fIlibssh2_scp_recv2(3)\fP function instead!
16

17
\fIsession\fP - Session instance as returned by
18
.BR libssh2_session_init_ex(3)
19

20
\fIpath\fP - Full path and filename of file to transfer. That is the remote
21
file name.
22

23
\fIsb\fP - Populated with remote file's size, mode, mtime, and atime
24

25
Request a file from the remote host via SCP.
26
.SH RETURN VALUE
27
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
28
.SH ERRORS
29
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
30

31
\fILIBSSH2_ERROR_SCP_PROTOCOL\fP -
32

33
\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would
34
block.
35
.SH SEE ALSO
36
.BR libssh2_session_init_ex(3)
37
.BR libssh2_channel_open_ex(3)
38