Content-type: text/html Man page of libssh2_sftp_write

libssh2_sftp_write

Section: libssh2 manual (3)
Updated: 1 Jun 2007
Index Return to Main Contents
 

NAME

libssh2_sftp_write - write SFTP data  

SYNOPSIS

#include <libssh2.h> #include <libssh2_sftp.h>

ssize_t libssh2_sftp_write(LIBSSH2_SFTP_HANDLE *handle, const char *buffer, size_t count);

 

DESCRIPTION

handle - SFTP File Handle as returned by libssh2_sftp_open_ex(3)

buffer - Pre-initialized data buffer to write to the LIBSSH2_SFTP_HANDLE.

count - Number of bytes from buffer to write. Note that it may not be possible to write all bytes as requested.

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.

 

RETURN VALUE

Actual number of bytes written or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.

 

ERRORS

LIBSSH2_ERROR_ALLOC - An internal memory allocation call failed.

LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.

LIBSSH2_ERROR_SOCKET_TIMEOUT -

LIBSSH2_ERROR_SFTP_PROTOCOL - An invalid SFTP protocol response was received on the socket, or an SFTP operation caused an errorcode to be returned by the server.

 

SEE ALSO

libssh2_sftp_open_ex(3)


 

Index

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
ERRORS
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 04:14:16 GMT, September 24, 2010