libssh2/share/man/man3/libssh2_scp_recv.3

   1 .\" $Id: libssh2_scp_recv.3,v 1.1 2007/06/14 14:56:32 jehousley Exp $
   2 .\"
   3 .TH libssh2_scp_recv 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_scp_recv - request a remote file via SCP
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 LIBSSH2_CHANNEL *
  10 libssh2_scp_recv(LIBSSH2_SESSION *session, const char *path, struct stat *sb);
  11
  12 .SH DESCRIPTION
  13 \fIsession\fP - Session instance as returned by
  14 .BR libssh2_session_init(3)
  15
  16 \fIpath\fP - Full path and filename of file to transfer
  17
  18 \fIsb\fP - Populated with remote file's size, mode, mtime, and atime
  19
  20 Request a file from the remote host via SCP. This
  21 function acts as a wrapper calling
  22 .BR libssh2_channel_open_session(3)
  23 ,
  24 .BR libssh2_channel_exec(3)
  25 , and negotiating rcp protocol handshakes.
  26
  27 .SH RETURN VALUE
  28 Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
  29
  30 .SH ERRORS
  31 \fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
  32
  33 \fILIBSSH2_ERROR_SCP_PROTOCOL\fP -
  34
  35 \fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block.
  36
  37 .SH SEE ALSO
  38 .BR libssh2_session_init(3)
  39 .BR libssh2_channel_open_session(3)
  40 .BR libssh2_channel_exec(3)