mirror of
https://github.com/libssh2/libssh2.git
synced 2025-10-24 14:53:03 +03:00
b889b39945
To render in Git webviews as-is, to make it easier to edit, verify,
and to sync up with curl.
- add options to not build the `.3` man pages:
- autotools: `--disable-docs`
- cmake: `LIBSSH2_BUILD_DOCS=OFF`
- building `.3` man pages requires Perl after this patch.
- drop `mansyntax` and the shell / `grep` / GNU `man` tool requirements with it.
- scripts and most logic were copied from curl.
- add `cd2nroff` from curl, with edits to relax curl-specific checks.
- used `nroff2cd` (from curl) to convert from `.3` to `.md`. Then
manually fixed copyrights, inline function references and a couple
of other things.
Credits-to: Daniel Stenberg
Ref: eefcc1bda4
Ref: https://github.com/curl/curl/pull/12730
Ref: https://github.com/libssh2/www/issues/25#issuecomment-3289431671
Closes #1660
60 lines
1.5 KiB
Markdown
60 lines
1.5 KiB
Markdown
---
|
|
c: Copyright (C) The libssh2 project and its contributors.
|
|
SPDX-License-Identifier: BSD-3-Clause
|
|
Title: libssh2_sftp_read
|
|
Section: 3
|
|
Source: libssh2
|
|
See-also:
|
|
- libssh2_sftp_open_ex(3)
|
|
- libssh2_sftp_read(3)
|
|
- read(2)
|
|
---
|
|
|
|
# NAME
|
|
|
|
libssh2_sftp_read - read data from an SFTP handle
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <libssh2.h>
|
|
#include <libssh2_sftp.h>
|
|
|
|
ssize_t
|
|
libssh2_sftp_read(LIBSSH2_SFTP_HANDLE *handle,
|
|
char *buffer, size_t buffer_maxlen);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
*handle* is the SFTP File Handle as returned by libssh2_sftp_open_ex(3)
|
|
|
|
*buffer* is a pointer to a pre-allocated buffer of at least
|
|
|
|
*buffer_maxlen* bytes to read data into.
|
|
|
|
Reads a block of data from an LIBSSH2_SFTP_HANDLE. This method is modelled
|
|
after the POSIX read(2)
|
|
function and uses the same calling semantics. libssh2_sftp_read(3)
|
|
will attempt to read as much as possible however it may not fill all of buffer
|
|
if the file pointer reaches the end or if further reads would cause the socket
|
|
to block.
|
|
|
|
# RETURN VALUE
|
|
|
|
Number of bytes actually populated into buffer, or negative on failure.
|
|
It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not 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.
|