mirror of
https://github.com/libssh2/libssh2.git
synced 2025-11-03 22:13:11 +03:00
30 lines
1.1 KiB
Groff
30 lines
1.1 KiB
Groff
.\" $Id: libssh2_session_init.3,v 1.1 2006/12/21 14:09:13 bagder Exp $
|
|
.\"
|
|
.TH libssh2_session_init 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_session_init - initializes an SSH session object
|
|
.SH SYNOPSIS
|
|
#include <libssh2.h>
|
|
|
|
LIBSSH2_SESSION *libssh2_session_init_ex(
|
|
LIBSSH2_ALLOC_FUNC((*myalloc)),
|
|
LIBSSH2_FREE_FUNC((*myfree)),
|
|
LIBSSH2_REALLOC_FUNC((*myrealloc)),
|
|
void *abstract);
|
|
|
|
LIBSSH2_SESSION *libssh2_session_init(void);
|
|
.SH DESCRIPTION
|
|
Initializes an SSH session object. By default system memory allocators
|
|
(malloc(), free(), realloc()) will be used for any dynamicly allocated memory
|
|
blocks. Alternate memory allocation functions may be specified using the
|
|
extended version of this API call, and/or optional application specific data
|
|
may be attached to the session object.
|
|
|
|
This method must be called first, prior to configuring session options or
|
|
starting up an SSH session with a remote server.
|
|
.SH RETURN VALUE
|
|
Pointer to a newly allocated LIBSSH2_SESSION instance, or NULL on errors.
|
|
.SH "SEE ALSO"
|
|
.BI libssh2_session_free(3),
|
|
.BI libssh2_session_startup(3)
|