1libssh2_channel_x11_req_ex(3)       libssh2      libssh2_channel_x11_req_ex(3)
2
3
4

NAME

6       libssh2_channel_x11_req_ex - request an X11 forwarding channel
7

SYNOPSIS

9       #include <libssh2.h>
10
11       int
12       libssh2_channel_x11_req_ex(LIBSSH2_CHANNEL *channel, int single_connection,
13                                  const char *auth_proto, const char *auth_cookie,
14                                  int screen_number);
15
16       int
17       libssh2_channel_x11_req(LIBSSH2_CHANNEL *channel,
18                               int screen_number);
19

DESCRIPTION

21       channel  -  Previously opened channel instance such as returned by lib‐
22       ssh2_channel_open_ex(3)
23
24       single_connection - non-zero to only forward a single connection.
25
26       auth_proto - X11 authentication protocol to use
27
28       auth_cookie - the cookie (hexadecimal encoded).
29
30       screen_number - the XLL screen to forward
31
32       Request an X11 forwarding on  channel.  To  use  X11  forwarding,  lib‐
33       ssh2_session_callback_set(3)  must first be called to set LIBSSH2_CALL‐
34       BACK_X11. This callback will be invoked when the  remote  host  accepts
35       the X11 forwarding.
36

RETURN VALUE

38       Return  0  on  success  or negative on failure.  It returns LIBSSH2_ER‐
39       ROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is
40       a negative number, it is not really a failure per se.
41

ERRORS

43       LIBSSH2_ERROR_ALLOC -  An internal memory allocation call failed.
44
45       LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.
46
47       LIBSSH2_ERROR_CHANNEL_REQUEST_DENIED -
48

SEE ALSO

50       libssh2_channel_open_ex(3) libssh2_session_callback_set(3)
51
52
53
54libssh2 0.15                      1 Jun 2007     libssh2_channel_x11_req_ex(3)
Impressum