Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_channel_process_startup (3ssh2)

Name

libssh2_channel_process_startup - request a shell on a channel

Synopsis

#include <libssh2.h>

int libssh2_channel_process_startup(LIBSSH2_CHANNEL *channel,
const char *request,
unsigned int request_len,
const char *message,
unsigned int message_len);

Description

libssh2 manual                          libssh2_channel_process_startup(3ssh2)



NAME
       libssh2_channel_process_startup - request a shell on a channel

SYNOPSIS
       #include <libssh2.h>

       int libssh2_channel_process_startup(LIBSSH2_CHANNEL *channel,
                                           const char *request,
                                           unsigned int request_len,
                                           const char *message,
                                           unsigned int message_len);

DESCRIPTION
       channel - Active session channel instance.

       request  -  Type  of  process  to  startup. The SSH2 protocol currently
       defines shell, exec, and subsystem as standard process services.

       request_len - Length of request parameter.

       message - Request specific message data to include.

       message_len - Length of message parameter.

       Initiate a request on a session type channel such as returned  by  lib-
       ssh2_channel_open_ex(3)

RETURN VALUE
       Return   0  on  success  or  negative  on  failure.   It  returns  LIB-
       SSH2_ERROR_EAGAIN  when  it   would   otherwise   block.   While   LIB-
       SSH2_ERROR_EAGAIN  is  a negative number, it isn't really a failure per
       se.

ERRORS
       LIBSSH2_ERROR_ALLOC -  An internal memory allocation call failed.

       LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.

       LIBSSH2_ERROR_CHANNEL_REQUEST_DENIED -


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


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

SEE ALSO
       libssh2_channel_open_ex(3)



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