libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_sftp_read 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_sftp_read - read data from an SFTP handle
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9
#include <libssh2_sftp.h>
10

11
ssize_t
12
libssh2_sftp_read(LIBSSH2_SFTP_HANDLE *handle,
13
                  char *buffer, size_t buffer_maxlen);
14
.fi
15
.SH DESCRIPTION
16
\fIhandle\fP is the SFTP File Handle as returned by
17
.BR libssh2_sftp_open_ex(3)
18

19
\fIbuffer\fP is a pointer to a pre-allocated buffer of at least
20

21
\fIbuffer_maxlen\fP bytes to read data into.
22

23
Reads a block of data from an LIBSSH2_SFTP_HANDLE. This method is modelled
24
after the POSIX
25
.BR read(2)
26
function and uses the same calling semantics.
27
.BR libssh2_sftp_read(3)
28
will attempt to read as much as possible however it may not fill all of buffer
29
if the file pointer reaches the end or if further reads would cause the socket
30
to block.
31
.SH RETURN VALUE
32
Number of bytes actually populated into buffer, or negative on failure.
33
It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
34
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
35
.SH ERRORS
36
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
37

38
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
39

40
\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP -
41

42
\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was
43
received on the socket, or an SFTP operation caused an errorcode to be
44
returned by the server.
45
.SH SEE ALSO
46
.BR libssh2_sftp_open_ex(3)
47
.BR libssh2_sftp_read(3)
48