mirror of
https://github.com/libssh2/libssh2.git
synced 2025-04-28 11:45:02 +03:00
e590450dcc
- add missing `.fi` tags. - fix misplaced `.nf` tags. - add `.nf`/`.fi` tags `SYNOPSIS` where missing. - fix missing/wrong function name from `SH NAME`. - fix wrong function name in `TH`. - keep return values in a separate line. - indent. - fold long lines. - deleted `libssh2_channel_direct_streamlocal()`, there is no such function. - add missing types. - add missing headers. Closes #949
20 lines
650 B
Groff
20 lines
650 B
Groff
.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
|
|
.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
|