libssh2

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

10
int
11
libssh2_channel_x11_req_ex(LIBSSH2_CHANNEL *channel, int single_connection,
12
                           const char *auth_proto, const char *auth_cookie,
13
                           int screen_number);
14

15
int
16
libssh2_channel_x11_req(LIBSSH2_CHANNEL *channel,
17
                        int screen_number);
18
.fi
19
.SH DESCRIPTION
20
\fIchannel\fP - Previously opened channel instance such as returned by
21
.BR libssh2_channel_open_ex(3)
22

23
\fIsingle_connection\fP - non-zero to only forward a single connection.
24

25
\fIauth_proto\fP - X11 authentication protocol to use
26

27
\fIauth_cookie\fP - the cookie (hexadecimal encoded).
28

29
\fIscreen_number\fP - the XLL screen to forward
30

31
Request an X11 forwarding on \fIchannel\fP. To use X11 forwarding,
32
.BR libssh2_session_callback_set2(3)
33
must first be called to set \fBLIBSSH2_CALLBACK_X11\fP. This callback will be
34
invoked when the remote host accepts the X11 forwarding.
35
.SH RETURN VALUE
36
Return 0 on success or negative on failure. It returns
37
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
38
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
39
.SH ERRORS
40
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
41

42
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
43

44
\fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP -
45
.SH SEE ALSO
46
.BR libssh2_channel_open_ex(3)
47
.BR libssh2_session_callback_set2(3)
48