51 lines
1.6 KiB
Groff
51 lines
1.6 KiB
Groff
|
.\" Copyright (C) The libssh2 project and its contributors.
|
||
|
|
.\" SPDX-License-Identifier: BSD-3-Clause
|
||
|
|
.TH libssh2_scp_send64 3 "17 Apr 2010" "libssh2 1.2.6" "libssh2"
|
||
|
|
.SH NAME
|
||
|
|
libssh2_scp_send64 - Send a file via SCP
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
#include <libssh2.h>
|
||
|
|
|
||
|
|
LIBSSH2_CHANNEL *
|
||
|
|
libssh2_scp_send64(LIBSSH2_SESSION *session, const char *path, int mode,
|
||
|
|
libssh2_uint64_t size, time_t mtime, time_t atime);
|
||
|
|
.fi
|
||
|
|
.SH DESCRIPTION
|
||
|
|
\fIsession\fP - Session instance as returned by
|
||
|
|
.BR libssh2_session_init_ex(3)
|
||
|
|
|
||
|
|
\fIpath\fP - Full path and filename of file to transfer to. That is the remote
|
||
|
|
file name.
|
||
|
|
|
||
|
|
\fImode\fP - File access mode to create file with
|
||
|
|
|
||
|
|
\fIsize\fP - Size of file being transmitted (Must be known ahead of
|
||
|
|
time). Note that this needs to be passed on as variable type
|
||
|
|
libssh2_uint64_t. This type is 64 bit on modern operating systems and
|
||
|
|
compilers.
|
||
|
|
|
||
|
|
\fImtime\fP - mtime to assign to file being created
|
||
|
|
|
||
|
|
\fIatime\fP - atime to assign to file being created (Set this and
|
||
|
|
mtime to zero to instruct remote host to use current time).
|
||
|
|
|
||
|
|
Send a file to 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_SOCKET_SEND\fP - Unable to send data on socket.
|
||
|
|
|
||
|
|
\fILIBSSH2_ERROR_SCP_PROTOCOL\fP -
|
||
|
|
|
||
|
|
\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would
|
||
|
|
block.
|
||
|
|
.SH AVAILABILITY
|
||
|
|
This function was added in libssh2 1.2.6 and is meant to replace the former
|
||
|
|
\fIlibssh2_scp_send_ex(3)\fP function.
|
||
|
|
.SH SEE ALSO
|
||
|
|
.BR libssh2_channel_open_ex(3)
|