libssh2_channel_x11_req_ex.3 (1561B)
1.TH libssh2_channel_x11_req_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" 2.SH NAME 3libssh2_channel_x11_req_ex - request an X11 forwarding channel 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8int 9libssh2_channel_x11_req_ex(LIBSSH2_CHANNEL *channel, int single_connection, 10 const char *auth_proto, const char *auth_cookie, 11 int screen_number); 12 13int 14libssh2_channel_x11_req(LIBSSH2_CHANNEL *channel, 15 int screen_number); 16.fi 17.SH DESCRIPTION 18\fIchannel\fP - Previously opened channel instance such as returned by 19.BR libssh2_channel_open_ex(3) 20 21\fIsingle_connection\fP - non-zero to only forward a single connection. 22 23\fIauth_proto\fP - X11 authentication protocol to use 24 25\fIauth_cookie\fP - the cookie (hexadecimal encoded). 26 27\fIscreen_number\fP - the XLL screen to forward 28 29Request an X11 forwarding on \fIchannel\fP. To use X11 forwarding, 30.BR libssh2_session_callback_set(3) 31must first be called to set \fBLIBSSH2_CALLBACK_X11\fP. This callback will be 32invoked when the remote host accepts the X11 forwarding. 33.SH RETURN VALUE 34Return 0 on success or negative on failure. It returns 35LIBSSH2_ERROR_EAGAIN when it would otherwise block. While 36LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. 37.SH ERRORS 38\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. 39 40\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. 41 42\fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP - 43.SH SEE ALSO 44.BR libssh2_channel_open_ex(3) 45.BR libssh2_session_callback_set(3)