1 .\" $Id: libssh2_channel_request_pty_ex.3,v 1.1 2007/06/13 21:07:59 jehousley Exp $
3 .TH libssh2_channel_request_pty_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
5 libssh2_channel_request_pty_ex - short function description
10 libssh2_channel_request_pty_ex(LIBSSH2_CHANNEL *channel, const char *term, unsigned int term_len, const char *modes, unsigned int modes_len, int width, int height, int width_px, int height_px);
13 libssh2_channel_request_pty(LIBSSH2_CHANNEL *channel, char *term);
16 \fIchannel\fP - Previously opened channel instance such as returned by
17 .BR libssh2_channel_open_session(3)
19 \fIterm\fP - Terminal emulation (e.g. vt102, ansi, etc...)
21 \fIterm_len\fP - Length of term parameter
23 \fImodes\fP - Terminal mode modifier values
25 \fImodes_len\fP - Length of modes parameter.
27 \fIwidth\fP - Width of pty in characters
29 \fIheight\fP - Height of pty in characters
31 \fIwidth_px\fP - Width of pty in pixels
33 \fIheight_px\fP - Height of pty in pixels
35 Request a PTY on an established channel. Note that this does not make sense
36 for all channel types and may be ignored by the server despite returning
40 Return 0 on success or negative on failure. It returns
41 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
42 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
45 \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
47 \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
49 \fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP -
52 .BR libssh2_channel_open_session(3)