libssh2_channel_request_pty_ex.3 (1676B)
1.TH libssh2_channel_request_pty_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" 2.SH NAME 3libssh2_channel_request_pty_ex - short function description 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8int 9libssh2_channel_request_pty_ex(LIBSSH2_CHANNEL *channel, const char *term, 10 unsigned int term_len, 11 const char *modes, unsigned int modes_len, 12 int width, int height, 13 int width_px, int height_px); 14 15int 16libssh2_channel_request_pty(LIBSSH2_CHANNEL *channel, const char *term); 17.fi 18.SH DESCRIPTION 19\fIchannel\fP - Previously opened channel instance such as returned by 20.BR libssh2_channel_open_ex(3) 21 22\fIterm\fP - Terminal emulation (e.g. vt102, ansi, etc...) 23 24\fIterm_len\fP - Length of term parameter 25 26\fImodes\fP - Terminal mode modifier values 27 28\fImodes_len\fP - Length of modes parameter. 29 30\fIwidth\fP - Width of pty in characters 31 32\fIheight\fP - Height of pty in characters 33 34\fIwidth_px\fP - Width of pty in pixels 35 36\fIheight_px\fP - Height of pty in pixels 37 38Request a PTY on an established channel. Note that this does not make sense 39for all channel types and may be ignored by the server despite returning 40success. 41.SH RETURN VALUE 42Return 0 on success or negative on failure. It returns 43LIBSSH2_ERROR_EAGAIN when it would otherwise block. While 44LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. 45.SH ERRORS 46\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. 47 48\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. 49 50\fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP - 51.SH SEE ALSO 52.BR libssh2_channel_open_ex(3)