libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_trace_sethandler 3 "15 Jan 2010" "libssh2" "libssh2"
4
.SH NAME
5
libssh2_trace_sethandler - set a trace output handler
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
typedef void (*libssh2_trace_handler_func)(LIBSSH2_SESSION *session,
11
                                           void *context,
12
                                           const char *data,
13
                                           size_t length);
14

15
int
16
libssh2_trace_sethandler(LIBSSH2_SESSION *session,
17
                         void *context,
18
                         libssh2_trace_handler_func callback);
19
.fi
20
.SH DESCRIPTION
21
libssh2_trace_sethandler installs a trace output handler for your application.
22
By default, when tracing has been switched on via a call to libssh2_trace(),
23
all output is written to stderr. By calling this method and passing a
24
function pointer that matches the libssh2_trace_handler_func prototype,
25
libssh2 will call back as it generates trace output. This can be used to
26
capture the trace output and put it into a log file or diagnostic window.
27
This function has no effect unless libssh2 was built to support this option,
28
and a typical "release build" might not.
29

30
\fBcontext\fP can be used to pass arbitrary user defined data back into the callback when invoked.
31
.SH AVAILABILITY
32
Added in libssh2 version 1.2.3
33