generic-library/ssh2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

libssh2_sftp_write: document buffer size and changed some ordering

Browse Source
This commit is contained in:
Daniel Stenberg 2010-06-13 17:00:14 +02:00
parent d7e6f9cf27
commit 33e2bc8785
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/libssh2_sftp_write.3
View File

@ -4,23 +4,29 @@
.SH NAME .SH NAME
libssh2_sftp_write - write SFTP data libssh2_sftp_write - write SFTP data
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
#include <libssh2_sftp.h> #include <libssh2_sftp.h>
ssize_t ssize_t libssh2_sftp_write(LIBSSH2_SFTP_HANDLE *handle,
libssh2_sftp_write(LIBSSH2_SFTP_HANDLE *handle, const char *buffer, size_t count); const char *buffer,
size_t count);
.SH DESCRIPTION .SH DESCRIPTION
\fBlibssh2_sftp_write(3)\fP writes a block of data to the SFTP server. This
method is modeled after the POSIX write() function and uses the same calling
semantics.
\fIhandle\fP - SFTP file handle as returned by \fIlibssh2_sftp_open_ex(3)\fP. \fIhandle\fP - SFTP file handle as returned by \fIlibssh2_sftp_open_ex(3)\fP.
\fIbuffer\fP - points to the data to send off \fIbuffer\fP - points to the data to send off.
\fIcount\fP - Number of bytes from 'buffer' to write. Note that it may not be \fIcount\fP - Number of bytes from 'buffer' to write. Note that it may not be
possible to write all bytes as requested. possible to write all bytes as requested.
\fBlibssh2_sftp_write(3)\fP writes a block of data to the SFTP server. This \fIlibssh2_sftp_handle(3)\fP will use as much as possible of the buffer and
method is modeled after the POSIX write() function and uses the same calling put it into a single SFTP protocol packet. This means that to get maximum
semantics. performance when sending larger files, you should try to always pass in at
least 32K of data to this function.
.SH RETURN VALUE .SH RETURN VALUE
Actual number of bytes written or negative on failure. Actual number of bytes written or negative on failure.