libssh2_trace_sethandler - set a trace output handler
#include <libssh2.h> typedef void (*libssh2_trace_handler_func)(LIBSSH2_SESSION *session, void* context, const char *data, size_t length); int libssh2_trace_sethandler(LIBSSH2_SESSION *session, void* context, libssh2_trace_handler_func callback);
libssh2 manual libssh2_trace_sethandler(3ssh2)
NAME
libssh2_trace_sethandler - set a trace output handler
SYNOPSIS
#include <libssh2.h>
typedef void (*libssh2_trace_handler_func)(LIBSSH2_SESSION *session,
void* context,
const char *data,
size_t length);
int libssh2_trace_sethandler(LIBSSH2_SESSION *session,
void* context,
libssh2_trace_handler_func callback);
DESCRIPTION
libssh2_trace_sethandler installs a trace output handler for your
application. By default, when tracing has been switched on via a call
to libssh2_trace(), all output is written to stderr. By calling this
method and passing a function pointer that matches the lib-
ssh2_trace_handler_func prototype, libssh2 will call back as it gener-
ates trace output. This can be used to capture the trace output and
put it into a log file or diagnostic window. This function has no
effect unless libssh2 was built to support this option, and a typical
"release build" might not.
context can be used to pass arbitrary user defined data back into the
callback when invoked.
AVAILABILITY
Added in libssh2 version 1.2.3
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | library/libssh2 |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://www.libssh2.org/download/lib-
ssh2-1.10.0.tar.gz.
Further information about this software can be found on the open source
community website at https://www.libssh2.org/.
libssh2 1.2.3 15 Jan 2010
libssh2_trace_sethandler(3ssh2)