Update to match current code and add errors
Этот коммит содержится в:
родитель
eac8fcdd77
Коммит
8bc4fdc3b0
@ -1,19 +1,34 @@
|
||||
.\" $Id: libssh2_session_init.3,v 1.4 2007/06/13 12:51:11 jehousley Exp $
|
||||
.\" $Id: libssh2_session_init.3,v 1.5 2007/06/13 13:57:53 jehousley Exp $
|
||||
.\"
|
||||
.TH libssh2_session_init 3 "1 June 2007" "libssh2 0.15" "libssh2 manual"
|
||||
.TH libssh2_session_init_ex 3 "1 June 2007" "libssh2 0.15" "libssh2 manual"
|
||||
.SH NAME
|
||||
libssh2_session_init - initializes an SSH session object
|
||||
libssh2_session_init_ex - 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_ex(LIBSSH2_ALLOC_FUNC((*myalloc)), LIBSSH2_FREE_FUNC((*myfree)), LIBSSH2_REALLOC_FUNC((*myrealloc)), void *abstract);
|
||||
|
||||
LIBSSH2_SESSION *
|
||||
libssh2_session_init(void);
|
||||
|
||||
LIBSSH2_SESSION *libssh2_session_init(void);
|
||||
.SH DESCRIPTION
|
||||
\fImyalloc\fP - Custom allocator function. Refer to the section on Callbacks
|
||||
for implementing an allocator callback. Pass a value of NULL to use the
|
||||
default system allocator.
|
||||
|
||||
\fImyfree\fP - Custom de-allocator function. Refer to the section on Callbacks
|
||||
for implementing a deallocator callback. Pass a value of NULL to use the
|
||||
default system deallocator.
|
||||
|
||||
\fImyrealloc\fP - Custom re-allocator function. Refer to the section on
|
||||
Callbacks for implementing a reallocator callback. Pass a value of NULL to
|
||||
use the default system reallocator.
|
||||
|
||||
\fIabstract\fP - Arbitrary pointer to application specific callback data.
|
||||
This value will be passed to any callback function associated with the named
|
||||
session instance.
|
||||
|
||||
Initializes an SSH session object. By default system memory allocators
|
||||
(malloc(), free(), realloc()) will be used for any dynamically allocated memory
|
||||
blocks. Alternate memory allocation functions may be specified using the
|
||||
@ -24,9 +39,6 @@ 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 ERRORS
|
||||
LIBSSH2_ERROR_EAGAIN
|
||||
Marked for non-blocking I/O but the call would block.
|
||||
.SH SEE ALSO
|
||||
.BI libssh2_session_free(3),
|
||||
.BI libssh2_session_startup(3)
|
||||
.BR libssh2_session_free(3)
|
||||
.BR libssh2_session_startup(3)
|
||||
|
Загрузка…
Ссылка в новой задаче
Block a user