libssh2\_agent\_init(3) libssh2 libssh2\_agent\_init(3)

# [NAME](#NAME)

libssh2\_agent\_init - init an ssh-agent handle

# [SYNOPSIS](#SYNOPSIS)

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

# [DESCRIPTION](#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(3)**](/man/os/libssh2/libssh2_agent_connect.3) to connect to a running ssh-agent.

Call [**libssh2\_agent\_free(3)**](/man/os/libssh2/libssh2_agent_free.3) to free the handle again after you are doing using it.

# [RETURN VALUE](#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](#AVAILABILITY)

Added in libssh2 1.2

# [SEE ALSO](#SEE_ALSO)

[**libssh2\_agent\_connect(3)**](/man/os/libssh2/libssh2_agent_connect.3) [**libssh2\_agent\_free(3)**](/man/os/libssh2/libssh2_agent_free.3)

23 Dec 2009 libssh2

---

Document: libssh2_agent_init(3) from libssh2 1.11.1-r10 (Chainguard OS)
Source: https://github.com/libssh2/libssh2.git
