libssh2/share/man/man3/libssh2_channel_get_exit_status.3

   1 .\" $Id: libssh2_channel_get_exit_status.3,v 1.1 2007/06/15 10:53:04 jehousley Exp $
   2 .\"
   3 .TH libssh2_channel_get_exit_status 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_channel_get_exit_status - get the remote exit code
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 int
  10 libssh2_channel_get_exit_status(LIBSSH2_CHANNEL* channel)
  11
  12 .SH DESCRIPTION
  13 \fIchannel\fP - Closed channel stream to retreive exit status from.
  14
  15 Returns the exit code raised by the process running on the remote host at
  16 the other end of the named channel. Note that the exit status may not be
  17 available if the remote end has not yet set its status to closed.
  18
  19 .SH RETURN VALUE
  20 Returns 0 on failure, otherwise the \fIExit Status\fP reported by remote host