mirror of
https://github.com/libssh2/libssh2.git
synced 2025-10-30 12:05:34 +03:00
47 lines
1.5 KiB
Groff
47 lines
1.5 KiB
Groff
.\" $Id: libssh2_channel_process_startup.3,v 1.2 2009/03/16 23:25:14 bagder Exp $
|
|
.\"
|
|
.TH libssh2_channel_process_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_channel_process_startup - request a shell on a channel
|
|
.SH 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);
|
|
|
|
int
|
|
libssh2_channel_shell(LIBSSH2_CHANNEL *channel);
|
|
|
|
int
|
|
libssh2_channel_exec(LIBSSH2_CHANNEL *channel, const char *message);
|
|
|
|
int
|
|
libssh2_channel_subsystem(LIBSSH2_CHANNEL *channel, const char *message);
|
|
|
|
.SH DESCRIPTION
|
|
\fIchannel\fP - Active session channel instance.
|
|
|
|
\fIrequest\fP - Type of process to startup. The SSH2 protocol currently
|
|
defines shell, exec, and subsystem as standard process services.
|
|
|
|
\fIrequest_len\fP - Length of request parameter.
|
|
|
|
\fImessage\fP - Request specific message data to include.
|
|
|
|
\fImessage_len\fP - Length of message parameter.
|
|
|
|
Initiate a request on a session type channel such as returned by
|
|
.BR libssh2_channel_open_ex(3)
|
|
.SH RETURN VALUE
|
|
Return 0 on success or negative on failure. It returns
|
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
|
LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
|
|
.SH ERRORS
|
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
|
|
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
|
|
|
\fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP -
|
|
.SH SEE ALSO
|
|
.BR libssh2_channel_open_ex(3)
|