summaryrefslogtreecommitdiffstats
path: root/doc/doxyout/krb5/man/man3/krb5_error.3
blob: 7ada02c39977fd696851703b7dac7534d1b5eeb8 (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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
.TH "Heimdal Kerberos 5 error reporting functions" 3 "30 Sep 2011" "Version 1.5.1" "HeimdalKerberos5library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Heimdal Kerberos 5 error reporting functions \- 
.SS "Functions"

.in +1c
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_eai_to_heim_errno\fP (int eai_errno, int system_error)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_h_errno_to_heim_errno\fP (int eai_errno)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_clear_error_message\fP (krb5_context context)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_set_error_message\fP (krb5_context context, krb5_error_code ret, const char *fmt,...) __attribute__((format(printf"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_vwarn\fP (krb5_context context, krb5_error_code code, const char *fmt, va_list ap) __attribute__((format(printf"
.br
.in -1c
.SH "Detailed Description"
.PP 

.SH "Function Documentation"
.PP 
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_clear_error_message (krb5_context context)"
.PP
Clears the error message from the Kerberos 5 context.
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP The Kerberos 5 context to clear 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_eai_to_heim_errno (int eai_errno, int system_error)"
.PP
Convert the getaddrinfo() error code to a Kerberos et error code.
.PP
\fBParameters:\fP
.RS 4
\fIeai_errno\fP contains the error code from getaddrinfo(). 
.br
\fIsystem_error\fP should have the value of errno after the failed getaddrinfo().
.RE
.PP
\fBReturns:\fP
.RS 4
Kerberos error code representing the EAI errors. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_h_errno_to_heim_errno (int eai_errno)"
.PP
Convert the gethostname() error code (h_error) to a Kerberos et error code.
.PP
\fBParameters:\fP
.RS 4
\fIeai_errno\fP contains the error code from gethostname().
.RE
.PP
\fBReturns:\fP
.RS 4
Kerberos error code representing the gethostname errors. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_set_error_message (krb5_context context, krb5_error_code ret, const char * fmt,  ...)"
.PP
Set the context full error string for a specific error code. The error that is stored should be internationalized.
.PP
The if context is NULL, no error string is stored.
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP Kerberos 5 context 
.br
\fIret\fP The error code 
.br
\fIfmt\fP Error string for the error code 
.br
\fI...\fP printf(3) style parameters. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_vwarn (krb5_context context, krb5_error_code code, const char * fmt, va_list ap)"
.PP
Log a warning to the log, default stderr, include the error from the last failure.
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP A Kerberos 5 context. 
.br
\fIcode\fP error code of the last error 
.br
\fIfmt\fP message to print 
.br
\fIap\fP arguments 
.RE
.PP

OpenPOWER on IntegriCloud