libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_channel_get_exit_status 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_channel_get_exit_status - get the remote exit code
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
int
11
libssh2_channel_get_exit_status(LIBSSH2_CHANNEL* channel)
12
.fi
13
.SH DESCRIPTION
14
\fIchannel\fP - Closed channel stream to retrieve exit status from.
15

16
Returns the exit code raised by the process running on the remote host at
17
the other end of the named channel. Note that the exit status may not be
18
available if the remote end has not yet set its status to closed.
19
.SH RETURN VALUE
20
Returns 0 on failure, otherwise the \fIExit Status\fP reported by remote host
21