libssh2_channel_request_auth_agent.3 (865B)
1.TH libssh2_channel_request_auth_agent 3 "1 Jun 2007" "libssh2 0.15" "libssh2" 2.SH NAME 3libssh2_channel_request_auth_agent - request agent forwarding for a session 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8int 9libssh2_channel_request_auth_agent(LIBSSH2_CHANNEL *channel); 10.fi 11.SH DESCRIPTION 12Request that agent forwarding be enabled for this SSH session. This sends the 13request over this specific channel, which causes the agent listener to be 14started on the remote side upon success. This agent listener will then run 15for the duration of the SSH session. 16 17\fIchannel\fP - Previously opened channel instance such as returned by 18.BR libssh2_channel_open_ex(3) 19.SH RETURN VALUE 20Return 0 on success or negative on failure. It returns 21LIBSSH2_ERROR_EAGAIN when it would otherwise block. While 22LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.