Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_channel_get_exit_signal (3ssh2)

Name

libssh2_channel_get_exit_signal - get the remote exit signal

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);

Description

libssh2 manual                          libssh2_channel_get_exit_signal(3ssh2)



NAME
       libssh2_channel_get_exit_signal - get the remote exit signal

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);


DESCRIPTION
       channel - Closed channel stream to retrieve exit signal from.

       exitsignal  - If not NULL, is populated by reference with the exit sig-
       nal (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.

       exitsignal_len - If not NULL, is populated by reference with the length
       of exitsignal.

       errmsg  - 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.

       errmsg_len  - If not NULL, is populated by reference with the length of
       errmsg.

       langtag - 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.

       langtag_len - If not NULL, is populated by reference with the length of
       langtag.


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



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libssh2  |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source   was   downloaded  from   https://www.libssh2.org/download/lib-
       ssh2-1.10.0.tar.gz.

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



libssh2 1.2.8                     4 Oct 2010
                                        libssh2_channel_get_exit_signal(3ssh2)