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