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_status (3ssh2)

Name

libssh2_channel_get_exit_status - get the remote exit code

Synopsis

#include <libssh2.h>

int libssh2_channel_get_exit_status(LIBSSH2_CHANNEL* channel)

Description

libssh2 manual                          libssh2_channel_get_exit_status(3ssh2)



NAME
       libssh2_channel_get_exit_status - get the remote exit code

SYNOPSIS
       #include <libssh2.h>

       int libssh2_channel_get_exit_status(LIBSSH2_CHANNEL* channel)


DESCRIPTION
       channel - 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.


RETURN VALUE
       Returns 0 on failure, otherwise the Exit Status reported by remote host



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 0.15                      1 Jun 2007
                                        libssh2_channel_get_exit_status(3ssh2)