Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_scp_send64 (3ssh2)

Name

libssh2_scp_send64 - Send a file via SCP

Synopsis

#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);

Description

libssh2_scp_send64(3ssh2)       libssh2 manual       libssh2_scp_send64(3ssh2)



NAME
       libssh2_scp_send64 - Send a file via SCP

SYNOPSIS
       #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);

DESCRIPTION
       session - Session instance as returned by libssh2_session_init_ex(3)

       path  -  Full  path  and  filename  of file to transfer to. That is the
       remote file name.

       mode - File access mode to create file with

       size - 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.

       mtime - mtime to assign to file being created

       atime - 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.

RETURN VALUE
       Pointer  to  a  newly  allocated  LIBSSH2_CHANNEL  instance, or NULL on
       errors.


ERRORS
       LIBSSH2_ERROR_ALLOC -  An internal memory allocation call failed.

       LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.

       LIBSSH2_ERROR_SCP_PROTOCOL -

       LIBSSH2_ERROR_EAGAIN - Marked for non-blocking I/O but the  call  would
       block.

AVAILABILITY
       This  function  was  added in libssh2 1.2.6 and is meant to replace the
       former libssh2_scp_send_ex(3) function.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libssh2  |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       libssh2_channel_open_ex(3)



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source  was  downloaded   from    https://www.libssh2.org/download/lib-
       ssh2-1.10.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.libssh2.org/.



libssh2 1.2.6                     17 Apr 2010        libssh2_scp_send64(3ssh2)