summaryrefslogtreecommitdiff
path: root/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_get_exit_status.3
blob: 4a8c9e2fcd319d617732ba897aebfb235f871ae5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
.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 retrieve 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