src/vendor/libssh2-sys/libssh2/docs/libssh2_channel_read_ex.3

   1 .TH libssh2_channel_read_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   2 .SH NAME
   3 libssh2_channel_read_ex - read data from a channel stream
   4 .SH SYNOPSIS
   5 #include <libssh2.h>
   6
   7 ssize_t
   8 libssh2_channel_read_ex(LIBSSH2_CHANNEL *channel, int stream_id, char *buf, size_t buflen);
   9
  10 ssize_t
  11 libssh2_channel_read(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen);
  12
  13 ssize_t
  14 libssh2_channel_read_stderr(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen);
  15
  16 .SH DESCRIPTION
  17 Attempt to read data from an active channel stream. All channel streams have
  18 one standard I/O substream (stream_id == 0), and may have up to 2^32 extended
  19 data streams as identified by the selected \fIstream_id\fP. The SSH2 protocol
  20 currently defines a stream ID of 1 to be the stderr substream.
  21
  22 \fIchannel\fP - active channel stream to read from.
  23
  24 \fIstream_id\fP - substream ID number (e.g. 0 or SSH_EXTENDED_DATA_STDERR)
  25
  26 \fIbuf\fP - pointer to storage buffer to read data into
  27
  28 \fIbuflen\fP - size of the buf storage
  29
  30 \fIlibssh2_channel_read(3)\fP and \fIlibssh2_channel_read_stderr(3)\fP are
  31 macros.
  32 .SH RETURN VALUE
  33 Actual number of bytes read or negative on failure. It returns
  34 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  35 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
  36
  37 Note that a return value of zero (0) can in fact be a legitimate value and
  38 only signals that no payload data was read. It is not an error.
  39 .SH ERRORS
  40 \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
  41
  42 \fILIBSSH2_ERROR_CHANNEL_CLOSED\fP - The channel has been closed.
  43
  44 .SH SEE ALSO
  45 .BR libssh2_poll_channel_read(3)