Name

libssh2_agent_init - init an ssh-agent handle

Synopsis

#include <libssh2.h>
 
LIBSSH2_AGENT *
libssh2_agent_init(LIBSSH2_SESSION *session);

Description

Init an ssh-agent handle. Returns the handle to an internal representation of an ssh-agent connection. After the successful initialization, an application can call libssh2_agent_connect to connect to a running ssh-agent.

Call libssh2_agent_free to free the handle again after you are doing using it.

Return value

Returns a handle pointer or NULL if something went wrong. The returned handle is used as input to all other ssh-agent related functions libssh2 provides.

Availability

Added in libssh2 1.2

See also

libssh2_agent_connect libssh2_agent_free

This HTML page was made with roffit.