Poster of Linux kernelThe best gift for a Linux geek
libssh2_session_init_ex

libssh2_session_init_ex

Section: libssh2 manual (3) Updated: 1 Jun 2007
Local index Up
 

NAME

libssh2_session_init_ex - initializes an SSH session object  

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);

 

DESCRIPTION

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

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

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

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

RETURN VALUE

Pointer to a newly allocated LIBSSH2_SESSION instance, or NULL on errors.  

SEE ALSO

libssh2_session_free(3) libssh2_session_startup(3)


 

Index

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 21:49:22 GMT, April 16, 2011