1 .TH "Heimdal Kerberos 5 error reporting functions" 3 "11 Jan 2012" "Version 1.5.2" "HeimdalKerberos5library" \" -*- nroff -*-
5 Heimdal Kerberos 5 error reporting functions \-
10 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_eai_to_heim_errno\fP (int eai_errno, int system_error)"
13 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_h_errno_to_heim_errno\fP (int eai_errno)"
16 .RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_clear_error_message\fP (krb5_context context)"
19 .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"
22 .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"
25 .SH "Detailed Description"
28 .SH "Function Documentation"
30 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_clear_error_message (krb5_context context)"
32 Clears the error message from the Kerberos 5 context.
36 \fIcontext\fP The Kerberos 5 context to clear
40 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_eai_to_heim_errno (int eai_errno, int system_error)"
42 Convert the getaddrinfo() error code to a Kerberos et error code.
46 \fIeai_errno\fP contains the error code from getaddrinfo().
48 \fIsystem_error\fP should have the value of errno after the failed getaddrinfo().
53 Kerberos error code representing the EAI errors.
57 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_h_errno_to_heim_errno (int eai_errno)"
59 Convert the gethostname() error code (h_error) to a Kerberos et error code.
63 \fIeai_errno\fP contains the error code from gethostname().
68 Kerberos error code representing the gethostname errors.
72 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_set_error_message (krb5_context context, krb5_error_code ret, const char * fmt, ...)"
74 Set the context full error string for a specific error code. The error that is stored should be internationalized.
76 The if context is NULL, no error string is stored.
80 \fIcontext\fP Kerberos 5 context
82 \fIret\fP The error code
84 \fIfmt\fP Error string for the error code
86 \fI...\fP printf(3) style parameters.
90 .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)"
92 Log a warning to the log, default stderr, include the error from the last failure.
96 \fIcontext\fP A Kerberos 5 context.
98 \fIcode\fP error code of the last error
100 \fIfmt\fP message to print