1libssh2_channel_x11_req_ex(3)   libssh2 manual   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   libssh2_channel_x11_req_ex(LIBSSH2_CHANNEL   *channel,  int  sin‐
12       gle_connection, const char *auth_proto, const  char  *auth_cookie,  int
13       screen_number);
14
15       int  libssh2_channel_x11_req(LIBSSH2_CHANNEL  *channel, int screen_num‐
16       ber);
17
18

DESCRIPTION

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

RETURN VALUE

38       Return  0  on  success  or  negative  on  failure.   It  returns   LIB‐
39       SSH2_ERROR_EAGAIN   when   it   would   otherwise   block.  While  LIB‐
40       SSH2_ERROR_EAGAIN is a negative number, it isn't really a  failure  per
41       se.
42
43

ERRORS

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

SEE ALSO

53       libssh2_channel_open_session(3) libssh2_session_callback_set(3)
54
55
56
57libssh2 0.15                      1 Jun 2007     libssh2_channel_x11_req_ex(3)
Impressum