libssh2/share/man/man3/libssh2_scp_send_ex.3

   1 .\" $Id: libssh2_scp_send_ex.3,v 1.1 2007/06/14 14:56:32 jehousley Exp $
   2 .\"
   3 .TH libssh2_scp_send_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_scp_send_ex - Send a file via SCP
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 LIBSSH2_CHANNEL *
  10 libssh2_scp_send_ex(LIBSSH2_SESSION *session, const char *path, int mode, size_t size, long mtime, long atime);
  11
  12 LIBSSH2_CHANNEL *
  13 libssh2_scp_send_ex(LIBSSH2_SESSION *session, const char *path, int mode, size_t size);
  14
  15 .SH DESCRIPTION
  16 \fIsession\fP - Session instance as returned by
  17 .BR libssh2_session_init(3)
  18
  19 \fIpath\fP - Full path and filename of file to transfer
  20
  21 \fImode\fP - File access mode to create file with
  22
  23 \fIsize\fP - Size of file being transmitted (Must be known
  24 ahead of time precisely)
  25
  26 \fImtime\fP - mtime to assign to file being created
  27
  28 \fIatime\fP - atime to assign to file being created (Set this and
  29 mtime to zero to instruct remote host to use current time).
  30
  31 Send a file to the remote host via SCP. This function
  32 acts as a wrapper calling
  33 .BR libssh2_channel_open_session(3)
  34 ,
  35 .BR libssh2_channel_exec(3)
  36 , and negotiating rcp protocol handshakes.
  37
  38 .SH RETURN VALUE
  39 Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
  40
  41 .SH ERRORS
  42 \fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
  43
  44 \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
  45
  46 \fILIBSSH2_ERROR_SCP_PROTOCOL\fP -
  47
  48 \fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block.
  49
  50 .SH SEE ALSO
  51 .BR libssh2_channel_open_session(3)
  52 .BR libssh2_channel_exec(3)