libssh2_agent_init.3 (877B)
1.\" 2.\" Copyright (c) 2009 by Daiki Ueno 3.\" 4.TH libssh2_agent_init 3 "23 Dec 2009" "libssh2" "libssh2" 5.SH NAME 6libssh2_agent_init - init an ssh-agent handle 7.SH SYNOPSIS 8.nf 9#include <libssh2.h> 10 11LIBSSH2_AGENT * 12libssh2_agent_init(LIBSSH2_SESSION *session); 13.fi 14.SH DESCRIPTION 15Init an ssh-agent handle. Returns the handle to an internal 16representation of an ssh-agent connection. After the successful 17initialization, an application can call \fBlibssh2_agent_connect(3)\fP 18to connect to a running ssh-agent. 19 20Call \fBlibssh2_agent_free(3)\fP to free the handle again after you are 21doing using it. 22.SH RETURN VALUE 23Returns a handle pointer or NULL if something went wrong. The returned handle 24is used as input to all other ssh-agent related functions libssh2 provides. 25.SH AVAILABILITY 26Added in libssh2 1.2 27.SH SEE ALSO 28.BR libssh2_agent_connect(3) 29.BR libssh2_agent_free(3)