libssh2_channel_get_exit_signal.3 (1555B)
1.TH libssh2_channel_get_exit_signal 3 "4 Oct 2010" "libssh2 1.2.8" "libssh2" 2.SH NAME 3libssh2_channel_get_exit_signal - get the remote exit signal 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8int 9libssh2_channel_get_exit_signal(LIBSSH2_CHANNEL *channel, 10 char **exitsignal, size_t *exitsignal_len, 11 char **errmsg, size_t *errmsg_len, 12 char **langtag, size_t *langtag_len); 13.fi 14.SH DESCRIPTION 15\fIchannel\fP - Closed channel stream to retrieve exit signal from. 16 17\fIexitsignal\fP - If not NULL, is populated by reference with the exit signal 18(without leading "SIG"). Note that the string is stored in a newly allocated 19buffer. If the remote program exited cleanly, the referenced string pointer 20will be set to NULL. 21 22\fIexitsignal_len\fP - If not NULL, is populated by reference with the length 23of exitsignal. 24 25\fIerrmsg\fP - If not NULL, is populated by reference with the error message 26(if provided by remote server, if not it will be set to NULL). Note that the 27string is stored in a newly allocated buffer. 28 29\fIerrmsg_len\fP - If not NULL, is populated by reference with the length of errmsg. 30 31\fIlangtag\fP - If not NULL, is populated by reference with the language tag 32(if provided by remote server, if not it will be set to NULL). Note that the 33string is stored in a newly allocated buffer. 34 35\fIlangtag_len\fP - If not NULL, is populated by reference with the length of langtag. 36.SH RETURN VALUE 37Numeric error code corresponding to the the Error Code constants.