Current File : //usr/share/man/man3ssh2/libssh2_channel_get_exit_signal.3ssh2

'\" te
.TH libssh2_channel_get_exit_signal 3 "4 Oct 2010" "libssh2 1.2.8" "libssh2 manual"
.SH NAME
libssh2_channel_get_exit_signal - get the remote exit signal
.SH SYNOPSIS
#include <libssh2.h>

int 
libssh2_channel_get_exit_signal(LIBSSH2_CHANNEL *channel, char **exitsignal, size_t *exitsignal_len, char **errmsg, size_t *errmsg_len, char **langtag, size_t *langtag_len);

.SH DESCRIPTION
\fIchannel\fP - Closed channel stream to retrieve exit signal from.

\fIexitsignal\fP - If not NULL, is populated by reference with the exit signal
(without leading "SIG"). Note that the string is stored in a newly allocated
buffer. If the remote program exited cleanly, the referenced string pointer
will be set to NULL. 

\fIexitsignal_len\fP - If not NULL, is populated by reference with the length
of exitsignal. 

\fIerrmsg\fP - If not NULL, is populated by reference with the error message
(if provided by remote server, if not it will be set to NULL). Note that the
string is stored in a newly allocated buffer.

\fIerrmsg_len\fP - If not NULL, is populated by reference with the length of errmsg.

\fIlangtag\fP - If not NULL, is populated by reference with the language tag 
(if provided by remote server, if not it will be set to NULL). Note that the
string is stored in a newly allocated buffer.

\fIlangtag_len\fP - If not NULL, is populated by reference with the length of langtag.

.SH RETURN VALUE
Numeric error code corresponding to the the Error Code constants.


.\" Oracle has added the ARC stability level to this manual page
.SH ATTRIBUTES
See
.BR attributes (5)
for descriptions of the following attributes:
.sp
.TS
box;
cbp-1 | cbp-1
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE 
=
Availability	library/libssh2
=
Stability	Uncommitted
.TE 
.PP

.SH NOTES

.\" Oracle has added source availability information to this manual page
This software was built from source available at https://java.net/projects/solaris-userland.  The original community source was downloaded from  http://www.libssh2.org/download/libssh2-1.4.2.tar.gz

Further information about this software can be found on the open source community website at http://www.libssh2.org/.