1libssh2_channel_request_pty_ex(3)libssh2 manuallibssh2_channel_request_pty_ex(3)
2
3
4

NAME

6       libssh2_channel_request_pty_ex - short function description
7

SYNOPSIS

9       #include <libssh2.h>
10
11       int libssh2_channel_request_pty_ex(LIBSSH2_CHANNEL *channel, const char
12       *term,  unsigned  int  term_len,  const  char  *modes,   unsigned   int
13       modes_len, int width, int height, int width_px, int height_px);
14
15       int libssh2_channel_request_pty(LIBSSH2_CHANNEL *channel, char *term);
16
17

DESCRIPTION

19       channel  -  Previously opened channel instance such as returned by lib‐
20       ssh2_channel_open_ex(3)
21
22       term - Terminal emulation (e.g. vt102, ansi, etc...)
23
24       term_len - Length of term parameter
25
26       modes - Terminal mode modifier values
27
28       modes_len - Length of modes parameter.
29
30       width - Width of pty in characters
31
32       height - Height of pty in characters
33
34       width_px - Width of pty in pixels
35
36       height_px - Height of pty in pixels
37
38       Request a PTY on an established channel. Note that this does  not  make
39       sense  for  all  channel types and may be ignored by the server despite
40       returning success.
41

RETURN VALUE

43       Return  0  on  success  or  negative  on  failure.   It  returns   LIB‐
44       SSH2_ERROR_EAGAIN   when   it   would   otherwise   block.  While  LIB‐
45       SSH2_ERROR_EAGAIN is a negative number, it isn't really a  failure  per
46       se.
47

ERRORS

49       LIBSSH2_ERROR_ALLOC -  An internal memory allocation call failed.
50
51       LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.
52
53       LIBSSH2_ERROR_CHANNEL_REQUEST_DENIED -
54

SEE ALSO

56       libssh2_channel_open_ex(3)
57
58
59
60libssh2 0.15                      1 Jun 2007 libssh2_channel_request_pty_ex(3)
Impressum