ssh2-python/libssh2/docs/libssh2_agent_init.3 at buffer_write · 7Learnings/ssh2-python

Repository navigation

.\" Copyright (C) Daiki Ueno

.\" SPDX-License-Identifier: BSD-3-Clause

.TH libssh2_agent_init 3 "23 Dec 2009" "libssh2" "libssh2"

.SH NAME

libssh2_agent_init - init an ssh-agent handle

.SH SYNOPSIS

.nf

#include <libssh2.h>

LIBSSH2_AGENT *

libssh2_agent_init(LIBSSH2_SESSION *session);

.fi

.SH 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 \fBlibssh2_agent_connect(3)\fP

to connect to a running ssh-agent.

Call \fBlibssh2_agent_free(3)\fP to free the handle again after you are

doing using it.

.SH 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.

.SH AVAILABILITY

Added in libssh2 1.2

.SH SEE ALSO

.BR libssh2_agent_connect(3)

.BR libssh2_agent_free(3)