libssh2_trace_sethandler.3 (1306B)
1.TH libssh2_trace_sethandler 3 "15 Jan 2010" "libssh2" "libssh2" 2.SH NAME 3libssh2_trace_sethandler - set a trace output handler 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8typedef void (*libssh2_trace_handler_func)(LIBSSH2_SESSION *session, 9 void *context, 10 const char *data, 11 size_t length); 12 13int 14libssh2_trace_sethandler(LIBSSH2_SESSION *session, 15 void *context, 16 libssh2_trace_handler_func callback); 17.fi 18.SH DESCRIPTION 19libssh2_trace_sethandler installs a trace output handler for your application. 20By default, when tracing has been switched on via a call to libssh2_trace(), 21all output is written to stderr. By calling this method and passing a 22function pointer that matches the libssh2_trace_handler_func prototype, 23libssh2 will call back as it generates trace output. This can be used to 24capture the trace output and put it into a log file or diagnostic window. 25This function has no effect unless libssh2 was built to support this option, 26and a typical "release build" might not. 27 28\fBcontext\fP can be used to pass arbitrary user defined data back into the callback when invoked. 29.SH AVAILABILITY 30Added in libssh2 version 1.2.3