crypto/heimdal/doc/doxyout/krb5/man/man3/krb5_error.3

   1 .TH "Heimdal Kerberos 5 error reporting functions" 3 "11 Jan 2012" "Version 1.5.2" "HeimdalKerberos5library" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 Heimdal Kerberos 5 error reporting functions \-
   6 .SS "Functions"
   7
   8 .in +1c
   9 .ti -1c
  10 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_eai_to_heim_errno\fP (int eai_errno, int system_error)"
  11 .br
  12 .ti -1c
  13 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_h_errno_to_heim_errno\fP (int eai_errno)"
  14 .br
  15 .ti -1c
  16 .RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_clear_error_message\fP (krb5_context context)"
  17 .br
  18 .ti -1c
  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"
  20 .br
  21 .ti -1c
  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"
  23 .br
  24 .in -1c
  25 .SH "Detailed Description"
  26 .PP
  27
  28 .SH "Function Documentation"
  29 .PP
  30 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_clear_error_message (krb5_context context)"
  31 .PP
  32 Clears the error message from the Kerberos 5 context.
  33 .PP
  34 \fBParameters:\fP
  35 .RS 4
  36 \fIcontext\fP The Kerberos 5 context to clear
  37 .RE
  38 .PP
  39
  40 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_eai_to_heim_errno (int eai_errno, int system_error)"
  41 .PP
  42 Convert the getaddrinfo() error code to a Kerberos et error code.
  43 .PP
  44 \fBParameters:\fP
  45 .RS 4
  46 \fIeai_errno\fP contains the error code from getaddrinfo().
  47 .br
  48 \fIsystem_error\fP should have the value of errno after the failed getaddrinfo().
  49 .RE
  50 .PP
  51 \fBReturns:\fP
  52 .RS 4
  53 Kerberos error code representing the EAI errors.
  54 .RE
  55 .PP
  56
  57 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_h_errno_to_heim_errno (int eai_errno)"
  58 .PP
  59 Convert the gethostname() error code (h_error) to a Kerberos et error code.
  60 .PP
  61 \fBParameters:\fP
  62 .RS 4
  63 \fIeai_errno\fP contains the error code from gethostname().
  64 .RE
  65 .PP
  66 \fBReturns:\fP
  67 .RS 4
  68 Kerberos error code representing the gethostname errors.
  69 .RE
  70 .PP
  71
  72 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_set_error_message (krb5_context context, krb5_error_code ret, const char * fmt,  ...)"
  73 .PP
  74 Set the context full error string for a specific error code. The error that is stored should be internationalized.
  75 .PP
  76 The if context is NULL, no error string is stored.
  77 .PP
  78 \fBParameters:\fP
  79 .RS 4
  80 \fIcontext\fP Kerberos 5 context
  81 .br
  82 \fIret\fP The error code
  83 .br
  84 \fIfmt\fP Error string for the error code
  85 .br
  86 \fI...\fP printf(3) style parameters.
  87 .RE
  88 .PP
  89
  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)"
  91 .PP
  92 Log a warning to the log, default stderr, include the error from the last failure.
  93 .PP
  94 \fBParameters:\fP
  95 .RS 4
  96 \fIcontext\fP A Kerberos 5 context.
  97 .br
  98 \fIcode\fP error code of the last error
  99 .br
 100 \fIfmt\fP message to print
 101 .br
 102 \fIap\fP arguments
 103 .RE
 104 .PP
 105