crypto/heimdal-0.6.3/lib/krb5/krb5_warn.3

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