libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_channel_request_pty_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_channel_request_pty_ex - short function description
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
int
11
libssh2_channel_request_pty_ex(LIBSSH2_CHANNEL *channel, const char *term,
12
                               unsigned int term_len,
13
                               const char *modes, unsigned int modes_len,
14
                               int width, int height,
15
                               int width_px, int height_px);
16

17
int
18
libssh2_channel_request_pty(LIBSSH2_CHANNEL *channel, const char *term);
19
.fi
20
.SH DESCRIPTION
21
\fIchannel\fP - Previously opened channel instance such as returned by
22
.BR libssh2_channel_open_ex(3)
23

24
\fIterm\fP - Terminal emulation (e.g. vt102, ansi, etc...)
25

26
\fIterm_len\fP - Length of term parameter
27

28
\fImodes\fP - Terminal mode modifier values
29

30
\fImodes_len\fP - Length of modes parameter.
31

32
\fIwidth\fP - Width of pty in characters
33

34
\fIheight\fP - Height of pty in characters
35

36
\fIwidth_px\fP - Width of pty in pixels
37

38
\fIheight_px\fP - Height of pty in pixels
39

40
Request a PTY on an established channel. Note that this does not make sense
41
for all channel types and may be ignored by the server despite returning
42
success.
43
.SH RETURN VALUE
44
Return 0 on success or negative on failure. It returns
45
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
46
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
47
.SH ERRORS
48
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
49

50
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
51

52
\fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP -
53
.SH SEE ALSO
54
.BR libssh2_channel_open_ex(3)
55