2009-03-17 11:34:27 +01:00
|
|
|
.\" $Id: libssh2_scp_recv.3,v 1.3 2009/03/17 10:34:27 bagder Exp $
|
2007-06-14 16:56:32 +02:00
|
|
|
.\"
|
|
|
|
|
.TH libssh2_scp_recv 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
|
|
|
|
.SH NAME
|
|
|
|
|
libssh2_scp_recv - request a remote file via SCP
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
#include <libssh2.h>
|
|
|
|
|
|
|
|
|
|
LIBSSH2_CHANNEL *
|
|
|
|
|
libssh2_scp_recv(LIBSSH2_SESSION *session, const char *path, struct stat *sb);
|
|
|
|
|
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
\fIsession\fP - Session instance as returned by
|
2009-03-17 11:34:27 +01:00
|
|
|
.BR libssh2_session_init_ex(3)
|
2007-06-14 16:56:32 +02:00
|
|
|
|
2009-09-22 23:54:10 +02:00
|
|
|
\fIpath\fP - Full path and filename of file to transfer. That is the remote
|
|
|
|
|
file name.
|
2007-06-14 16:56:32 +02:00
|
|
|
|
|
|
|
|
\fIsb\fP - Populated with remote file's size, mode, mtime, and atime
|
|
|
|
|
|
2009-03-17 00:25:14 +01:00
|
|
|
Request a file from the remote host via SCP.
|
2007-06-14 16:56:32 +02:00
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
|
|
|
|
|
.SH ERRORS
|
|
|
|
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
|
|
|
|
|
|
|
|
|
\fILIBSSH2_ERROR_SCP_PROTOCOL\fP -
|
|
|
|
|
|
2009-03-17 00:25:14 +01:00
|
|
|
\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would
|
|
|
|
|
block.
|
2007-06-14 16:56:32 +02:00
|
|
|
.SH SEE ALSO
|
2009-03-17 11:34:27 +01:00
|
|
|
.BR libssh2_session_init_ex(3)
|
2009-03-17 00:25:14 +01:00
|
|
|
.BR libssh2_channel_open_ex(3)
|
|
|
|
|
|
