lib/libssh2
1
0
Fork 0
mirror of https://github.com/libssh2/libssh2.git synced 2025-07-28 01:41:49 +03:00
Code Activity

Add libssh2_trace_sethandler() to the API (even more)

Browse Source
This commit is contained in:
Dave McCaldon
2010-01-15 22:58:44 +01:00
committed by Daniel Stenberg
parent 474e38119b
commit 44eba0c993
7 changed files with 80 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/Makefile.am
View File

@ -97,6 +97,7 @@ dist_man_MANS = \
libssh2_sftp_unlink_ex.3 \
libssh2_sftp_write.3 \
libssh2_trace.3 \
libssh2_trace_sethandler.3 \
libssh2_userauth_authenticated.3 \
libssh2_userauth_hostbased_fromfile_ex.3 \
libssh2_userauth_keyboard_interactive_ex.3 \

27
docs/libssh2_trace_sethandler.3
View File

@ -1,19 +1,26 @@
.\" $Id: libssh2_trace_sethandler.3,v 1.1 2008/12/26 07:46:45 bagder Exp $
.\"
.TH libssh2_trace_sethandler 3 "03 Nov 2009" "libssh2 1.2" "libssh2 manual"
.TH libssh2_trace_sethandler 3 "15 Jan 2010" "libssh2 1.2.3" "libssh2 manual"
.SH NAME
libssh2_trace_sethandler - set a trace output handler
.SH SYNOPSIS
.nf
#include <libssh2.h>
typedef void (*libssh2_trace_handler_func)(LIBSSH2_SESSION*, const char*, size_t);
LIBSSH2_API int libssh2_trace_sethandler(LIBSSH2_SESSION *session, libssh2_trace_handler_func callback);
typedef void (*libssh2_trace_handler_func)(LIBSSH2_SESSION *session,
const char *data,
size_t length);
int libssh2_trace_sethandler(LIBSSH2_SESSION *session,
libssh2_trace_handler_func callback);
.SH DESCRIPTION
This function can be called to install a trace output handler for your application. By default, when
tracing has been switched on via a call to libssh2_trace(), any 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.
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.
.SH AVAILABILITY
Added in libssh2 version 1.2.3