mirror of
https://github.com/libssh2/libssh2.git
synced 2025-10-30 12:05:34 +03:00
592e2b37fa
- simplify `.TH` headers. - delete empty lines before sections. - update template with an `AVAILABILITY` section. Left libssh2 version number in the `.TH` header for entries without an `AVAILABILITY` section, or where there was a different version number there.
31 lines
1.3 KiB
Groff
31 lines
1.3 KiB
Groff
.TH libssh2_trace_sethandler 3 "15 Jan 2010" "libssh2" "libssh2"
|
|
.SH NAME
|
|
libssh2_trace_sethandler - set a trace output handler
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#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);
|
|
.fi
|
|
.SH 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 libssh2_trace_handler_func prototype,
|
|
libssh2 will call back as it generates 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.
|
|
|
|
\fBcontext\fP can be used to pass arbitrary user defined data back into the callback when invoked.
|
|
.SH AVAILABILITY
|
|
Added in libssh2 version 1.2.3
|