mirror of
https://github.com/libssh2/libssh2.git
synced 2025-10-30 12:05:34 +03:00
592e2b37fa
- 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.
36 lines
1003 B
Groff
36 lines
1003 B
Groff
.TH libssh2_scp_recv 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
|
|
.SH NAME
|
|
libssh2_scp_recv - request a remote file via SCP
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
LIBSSH2_CHANNEL *
|
|
libssh2_scp_recv(LIBSSH2_SESSION *session, const char *path, struct stat *sb);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
This function is \fBDEPRECATED\fP. Use \fIlibssh2_scp_recv2(3)\fP
|
|
instead!
|
|
|
|
\fIsession\fP - Session instance as returned by
|
|
.BR libssh2_session_init_ex(3)
|
|
|
|
\fIpath\fP - Full path and filename of file to transfer. That is the remote
|
|
file name.
|
|
|
|
\fIsb\fP - Populated with remote file's size, mode, mtime, and atime
|
|
|
|
Request a file from the remote host via SCP.
|
|
.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 -
|
|
|
|
\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would
|
|
block.
|
|
.SH SEE ALSO
|
|
.BR libssh2_session_init_ex(3)
|
|
.BR libssh2_channel_open_ex(3)
|