libssh2_agent_init - agent handle
#include <libssh2.h> LIBSSH2_AGENT *libssh2_agent_init(LIBSSH2_SESSION *session);
libssh2_agent_init(3ssh2) libssh2 manual libssh2_agent_init(3ssh2)
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 representa-
tion of an ssh-agent connection. After the successful initialization,
an application can call libssh2_agent_connect(3) to connect to a run-
ning ssh-agent.
Call libssh2_agent_free(3) to free the handle again after you're 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 lib-
ssh2 provides.
AVAILABILITY
Added in libssh2 1.2
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | library/libssh2 |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
SEE ALSO
libssh2_agent_connect(3) libssh2_agent_free(3)
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://www.libssh2.org/download/lib-
ssh2-1.10.0.tar.gz.
Further information about this software can be found on the open source
community website at https://www.libssh2.org/.
libssh2 1.2 23 Dec 2009 libssh2_agent_init(3ssh2)