1libssh2_channel_request_pty_ex(3)   libssh2  libssh2_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
12       libssh2_channel_request_pty_ex(LIBSSH2_CHANNEL *channel, const char *term,
13                                      unsigned int term_len,
14                                      const char *modes, unsigned int modes_len,
15                                      int width, int height,
16                                      int width_px, int height_px);
17
18       int
19       libssh2_channel_request_pty(LIBSSH2_CHANNEL *channel, const char *term);
20

DESCRIPTION

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

RETURN VALUE

46       Return 0 on success or negative on  failure.   It  returns  LIBSSH2_ER‐
47       ROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is
48       a negative number, it is not really a failure per se.
49

ERRORS

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

SEE ALSO

58       libssh2_channel_open_ex(3)
59
60
61
62libssh2 0.15                      1 Jun 2007 libssh2_channel_request_pty_ex(3)
Impressum