libssh2/share/man/man3/libssh2_sftp_write.3

   1 .\" $Id: libssh2_sftp_write.3,v 1.1 2007/06/14 16:46:14 jehousley Exp $
   2 .\"
   3 .TH libssh2_sftp_rename_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_sftp_rename_ex - rename a file
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8 #include <libssh2_sftp.h>
   9
  10 ssize_t
  11 libssh2_sftp_write(LIBSSH2_SFTP_HANDLE *handle, const char *buffer, size_t count);
  12
  13 .SH DESCRIPTION
  14 \fIhandle\fP - SFTP File Handle as returned by
  15 .BR libssh2_sftp_open(3)
  16
  17 \fIbuffer\fP - Pre-initialized data buffer to write to the LIBSSH2_SFTP_HANDLE.
  18
  19 \fIcount\fP - Number of bytes from buffer to write. Note that it may not
  20 be possible to write all bytes as requested.
  21
  22 Write a block of data to a LIBSSH2_SFTP_HANDLE. This method is modeled after the POSIX write() function and uses the same calling semantics.
  23
  24 .SH RETURN VALUE
  25 Actual number of bytes written or negative on failure.  It returns
  26 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  27 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
  28
  29 .SH ERRORS
  30 \fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
  31
  32 \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
  33
  34 \fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP -
  35
  36 \fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was
  37 received on the socket, or an SFTP operation caused an errorcode to
  38 be returned by the server.
  39
  40 .SH SEE ALSO
  41 .BR libssh2_sftp_open(3)