Add libssh2_channel_get_exit_status()

This commit is contained in:
James Housley 2007-06-15 10:53:04 +00:00
parent bc6ab7e0cb
commit 8accb43cd6
2 changed files with 22 additions and 1 deletions

View File

@ -1,4 +1,4 @@
# $Id: Makefile.am,v 1.24 2007/06/14 17:23:13 jehousley Exp $
# $Id: Makefile.am,v 1.25 2007/06/15 10:53:04 jehousley Exp $
EXTRA_DIST = template.3
@ -12,6 +12,7 @@ dist_man_MANS =
libssh2_channel_forward_cancel.3 \
libssh2_channel_forward_listen_ex.3 \
libssh2_channel_free.3 \
libssh2_channel_get_exit_status.3 \
libssh2_channel_handle_extended_data.3 \
libssh2_channel_handle_extended_data2.3 \
libssh2_channel_open_ex.3 \

View File

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