libssh2/share/man/man3/libssh2_channel_process_startup.3

   1 .\" $Id: libssh2_channel_process_startup.3,v 1.1 2007/06/13 20:54:25 jehousley Exp $
   2 .\"
   3 .TH libssh2_channel_process_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_channel_process_startup - request a shell on a channel
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 int
  10 libssh2_channel_process_startup(LIBSSH2_CHANNEL *channel, const char *request, unsigned int request_len, const char *message, unsigned int message_len);
  11
  12 int
  13 libssh2_channel_shell(LIBSSH2_CHANNEL *channel);
  14
  15 int
  16 libssh2_channel_exec(LIBSSH2_CHANNEL *channel, const char *message);
  17
  18 int
  19 libssh2_channel_subsystem(LIBSSH2_CHANNEL *channel, const char *message);
  20
  21 .SH DESCRIPTION
  22 \fIchannel\fP - Active session channel instance.
  23
  24 \fIrequest\fP - Type of process to startup. The SSH2 protocol currently
  25 defines shell, exec, and subsystem as standard process services.
  26
  27 \fIrequest_len\fP - Length of request parameter.
  28
  29 \fImessage\fP - Request specific message data to include.
  30
  31 \fImessage_len\fP - Length of message parameter.
  32
  33 Initiate a request on a session type channel such as returned by
  34 .BR libssh2_channel_open_session(3)
  35
  36 .SH RETURN VALUE
  37 Return 0 on success or negative on failure.  It returns
  38 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  39 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
  40
  41 .SH ERRORS
  42 \fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
  43
  44 \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
  45
  46 \fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP -
  47
  48 .SH SEE ALSO
  49 .BR libssh2_channel_open_session(3)