mirror of
https://github.com/libssh2/libssh2.git
synced 2025-07-02 22:02:25 +03:00
592e2b37fa
- simplify `.TH` headers. - delete empty lines before sections. - update template with an `AVAILABILITY` section. Left libssh2 version number in the `.TH` header for entries without an `AVAILABILITY` section, or where there was a different version number there.
19 lines
642 B
Groff
19 lines
642 B
Groff
.TH libssh2_channel_get_exit_status 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
|
|
.SH NAME
|
|
libssh2_channel_get_exit_status - get the remote exit code
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_channel_get_exit_status(LIBSSH2_CHANNEL* channel)
|
|
.fi
|
|
.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
|