libssh2/share/man/man3/libssh2_channel_read_ex.3

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