xref: /freebsd/crypto/krb5/doc/html/_sources/appdev/refs/api/krb5_set_trace_callback.rst.txt (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1krb5_set_trace_callback -  Specify a callback function for trace events.
2=========================================================================
3
4..
5
6.. c:function:: krb5_error_code krb5_set_trace_callback(krb5_context context, krb5_trace_callback fn, void * cb_data)
7
8..
9
10
11:param:
12
13	          **[in]** **context** - Library context
14
15	          **[in]** **fn** - Callback function
16
17	          **[in]** **cb_data** - Callback data
18
19
20..
21
22
23
24:return:
25         -  Returns KRB5_TRACE_NOSUPP if tracing is not supported in the library (unless fn is NULL).
26
27..
28
29
30
31
32
33
34
35Specify a callback for trace events occurring in krb5 operations performed within *context* . *fn* will be invoked with *context* as the first argument, *cb_data* as the last argument, and a pointer to a krb5_trace_info as the second argument. If the trace callback is reset via this function or *context* is destroyed, *fn* will be invoked with a NULL second argument so it can clean up *cb_data* . Supply a NULL value for *fn* to disable trace callbacks within *context* .
36
37
38
39
40
41
42
43
44
45
46..
47
48
49
50
51
52
53.. note::
54
55	 This function overrides the information passed through the *KRB5_TRACE* environment variable.
56
57
58
59.. note::
60
61	 New in 1.9
62
63
64