oracular (3) libssh2_channel_request_auth_agent.3.gz

Provided by: libssh2-1-dev_1.11.0-7_amd64 bug

NAME
       libssh2_channel_request_auth_agent - request agent forwarding for a session


SYNOPSIS
       #include <libssh2.h>

       int
       libssh2_channel_request_auth_agent(LIBSSH2_CHANNEL *channel);


DESCRIPTION
       Request  that agent forwarding be enabled for this SSH session. This sends the request over this specific
       channel, which causes the agent listener to be started on  the  remote  side  upon  success.  This  agent
       listener will then run for the duration of the SSH session.

       channel - Previously opened channel instance such as returned by libssh2_channel_open_ex(3)


RETURN VALUE
       Return  0  on  success  or  negative on failure.  It returns LIBSSH2_ERROR_EAGAIN when it would otherwise
       block. While LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.