Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_scp_recv (3ssh2)

Name

libssh2_scp_recv - request a remote file via SCP

Synopsis

#include <libssh2.h>

LIBSSH2_CHANNEL * libssh2_scp_recv(LIBSSH2_SESSION *session, const char
*path, struct stat *sb);

Description

libssh2_scp_recv(3ssh2)         libssh2 manual         libssh2_scp_recv(3ssh2)



NAME
       libssh2_scp_recv - request a remote file via SCP

SYNOPSIS
       #include <libssh2.h>

       LIBSSH2_CHANNEL * libssh2_scp_recv(LIBSSH2_SESSION *session, const char
       *path, struct stat *sb);


DESCRIPTION
       This function is DEPRECATED. Use libssh2_scp_recv2(3) instead!

       session - Session instance as returned by libssh2_session_init_ex(3)

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

       sb - Populated with remote file's size, mode, mtime, and atime

       Request a file from 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_SCP_PROTOCOL -

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


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


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

SEE ALSO
       libssh2_session_init_ex(3) 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 0.15                      1 Jun 2007           libssh2_scp_recv(3ssh2)