From 546fe27744463548464890eba132345d9afeebbf Mon Sep 17 00:00:00 2001 From: Dave McCaldon Date: Tue, 3 Nov 2009 17:21:52 -0500 Subject: [PATCH] Added documentation for libssh2_trace_sethandler --- docs/libssh2_trace_sethandler.3 | 19 +++++++++++++++++++ 1 files changed, 19 insertions(+), 0 deletions(-) create mode 100644 docs/libssh2_trace_sethandler.3 diff --git a/docs/libssh2_trace_sethandler.3 b/docs/libssh2_trace_sethandler.3 new file mode 100644 index 0000000..7d57800 --- /dev/null +++ b/docs/libssh2_trace_sethandler.3 @@ -0,0 +1,19 @@ +.\" $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" +.SH NAME +libssh2_trace_sethandler - set a trace output handler +.SH SYNOPSIS +#include + +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); + +.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. -- 1.6.4.4