summaryrefslogtreecommitdiffstats
path: root/crypto/heimdal/lib/krb5/krb5_warn.3
blob: 7ed4b31fbc1d6e6705451ae3f50e6dd24bbcb4e5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
.\" Copyright (c) 1997 Kungliga Tekniska Högskolan
.\" $Id: krb5_warn.3,v 1.7 2003/04/16 19:31:49 lha Exp $
.Dd August 8, 1997
.Dt KRB5_WARN 3
.Os HEIMDAL
.Sh NAME
.Nm krb5_warn ,
.Nm krb5_warnx ,
.Nm krb5_vwarn ,
.Nm krb5_vwarnx ,
.Nm krb5_err ,
.Nm krb5_errx ,
.Nm krb5_verr ,
.Nm krb5_verrx ,
.Nm krb5_set_warn_dest
.Nd Heimdal warning and error functions
.Sh LIBRARY
Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
.In krb5.h
.Ft krb5_error_code
.Fn krb5_err "krb5_context context" "int eval" "krb5_error_code code" "const char *format" "..."
.Ft krb5_error_code
.Fn krb5_errx "krb5_context context" "int eval" "const char *format" "..."
.Ft krb5_error_code
.Fn krb5_verr "krb5_context context" "int eval" "krb5_error_code code" "const char *format" "va_list ap"
.Ft krb5_error_code
.Fn krb5_verrx "krb5_context context" "int eval" "const char *format" "va_list ap"
.Ft krb5_error_code
.Fn krb5_vwarn "krb5_context context" "krb5_error_code code" "const char *format" "va_list ap"
.Ft krb5_error_code
.Fn krb5_vwarnx "krb5_context context" "const char *format" "va_list ap"
.Ft krb5_error_code
.Fn krb5_warn "krb5_context context" "krb5_error_code code" "const char *format" "..."
.Ft krb5_error_code
.Fn krb5_warnx "krb5_context context" "const char *format" "..."
.Ft krb5_error_code
.Fn krb5_set_warn_dest "krb5_context context" "krb5_log_facility *facility"
.Ft "char *"
.Fn krb5_get_err_text "krb5_context context" "krb5_error_code code"
.Sh DESCRIPTION
These functions prints a warning message to some destination.
.Fa format
is a printf style format specifying the message to print. The forms not ending in an
.Dq x
prints the error string associated with
.Fa code
along with the message.
The
.Dq err
functions exits with exit status
.Fa eval
after printing the message.
.Pp
The
.Fn krb5_set_warn_func
function sets the destination for warning messages to the specified
.Fa facility .
Messages logged with the
.Dq warn
functions have a log level of 1, while the
.Dq err
functions logs with level 0.
.Pp
.Fn krb5_get_err_text
fetches the human readable strings describing the error-code.
.Sh SEE ALSO
.Xr krb5_openlog 3
OpenPOWER on IntegriCloud