libssh2/share/man/man3/libssh2_channel_flush_ex.3

   1 .\" $Id: libssh2_channel_flush_ex.3,v 1.1 2007/06/13 19:53:09 jehousley Exp $
   2 .\"
   3 .TH libssh2_channel_flush_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_channel_flush_ex - flush a channel
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 int
  10 libssh2_channel_flush_ex(LIBSSH2_CHANNEL *channel, int streamid);
  11
  12 int
  13 libssh2_channel_flush(LIBSSH2_CHANNEL *channel);
  14
  15 int
  16 libssh2_channel_flush_stderr(LIBSSH2_CHANNEL *channel);
  17
  18 .SH DESCRIPTION
  19 \fIchannel\fP - Active channel stream to flush.
  20
  21 \fIstreamid\fP - Specific substream number to flush. Groups of substreams may
  22 be flushed by passing on of the following Constants.
  23 .br
  24 \fBLIBSSH2_CHANNEL_FLUSH_EXTENDED_DATA\fP: Flush all extended data substreams
  25 .br
  26 \fBLIBSSH2_CHANNEL_FLUSH_ALL\fP: Flush all substreams
  27
  28 Flush the read buffer for a given channel instance. Individual substreams may
  29 be flushed by number or using one of the provided macros.
  30
  31 .SH RETURN VALUE
  32 Return 0 on success or negative on failure.  It returns
  33 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  34 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.