libssh2

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

10
LIBSSH2_CHANNEL *
11
libssh2_scp_recv2(LIBSSH2_SESSION *session, const char *path, struct_stat *sb);
12
.fi
13
.SH DESCRIPTION
14
\fIsession\fP - Session instance as returned by
15
.BR libssh2_session_init_ex(3)
16

17
\fIpath\fP - Full path and filename of file to transfer. That is the remote
18
file name.
19

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

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

28
\fILIBSSH2_ERROR_SCP_PROTOCOL\fP -
29

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