crypto/heimdal/doc/doxyout/hx509/man/man3/hx509_error.3

   1 .TH "hx509 error functions" 3 "11 Jan 2012" "Version 1.5.2" "Heimdalx509library" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 hx509 error functions \-
   6 .SS "Functions"
   7
   8 .in +1c
   9 .ti -1c
  10 .RI "void \fBhx509_clear_error_string\fP (hx509_context context)"
  11 .br
  12 .ti -1c
  13 .RI "void \fBhx509_set_error_stringv\fP (hx509_context context, int flags, int code, const char *fmt, va_list ap)"
  14 .br
  15 .ti -1c
  16 .RI "void \fBhx509_set_error_string\fP (hx509_context context, int flags, int code, const char *fmt,...)"
  17 .br
  18 .ti -1c
  19 .RI "char * \fBhx509_get_error_string\fP (hx509_context context, int error_code)"
  20 .br
  21 .ti -1c
  22 .RI "void \fBhx509_free_error_string\fP (char *str)"
  23 .br
  24 .ti -1c
  25 .RI "void \fBhx509_err\fP (hx509_context context, int exit_code, int error_code, const char *fmt,...)"
  26 .br
  27 .in -1c
  28 .SH "Detailed Description"
  29 .PP
  30 See the \fBHx509 error reporting functions\fP for description and examples.
  31 .SH "Function Documentation"
  32 .PP
  33 .SS "void hx509_clear_error_string (hx509_context context)"
  34 .PP
  35 Resets the error strings the hx509 context.
  36 .PP
  37 \fBParameters:\fP
  38 .RS 4
  39 \fIcontext\fP A hx509 context.
  40 .RE
  41 .PP
  42
  43 .SS "void hx509_err (hx509_context context, int exit_code, int error_code, const char * fmt,  ...)"
  44 .PP
  45 Print error message and fatally exit from error code
  46 .PP
  47 \fBParameters:\fP
  48 .RS 4
  49 \fIcontext\fP A hx509 context.
  50 .br
  51 \fIexit_code\fP exit() code from process.
  52 .br
  53 \fIerror_code\fP Error code for the reason to exit.
  54 .br
  55 \fIfmt\fP format string with the exit message.
  56 .br
  57 \fI...\fP argument to format string.
  58 .RE
  59 .PP
  60
  61 .SS "void hx509_free_error_string (char * str)"
  62 .PP
  63 Free error string returned by \fBhx509_get_error_string()\fP.
  64 .PP
  65 \fBParameters:\fP
  66 .RS 4
  67 \fIstr\fP error string to free.
  68 .RE
  69 .PP
  70
  71 .SS "char* hx509_get_error_string (hx509_context context, int error_code)"
  72 .PP
  73 Get an error string from context associated with error_code.
  74 .PP
  75 \fBParameters:\fP
  76 .RS 4
  77 \fIcontext\fP A hx509 context.
  78 .br
  79 \fIerror_code\fP Get error message for this error code.
  80 .RE
  81 .PP
  82 \fBReturns:\fP
  83 .RS 4
  84 error string, free with \fBhx509_free_error_string()\fP.
  85 .RE
  86 .PP
  87
  88 .SS "void hx509_set_error_string (hx509_context context, int flags, int code, const char * fmt,  ...)"
  89 .PP
  90 See \fBhx509_set_error_stringv()\fP.
  91 .PP
  92 \fBParameters:\fP
  93 .RS 4
  94 \fIcontext\fP A hx509 context.
  95 .br
  96 \fIflags\fP
  97 .IP "\(bu" 2
  98 HX509_ERROR_APPEND appends the error string to the old messages (code is updated).
  99 .PP
 100 .br
 101 \fIcode\fP error code related to error message
 102 .br
 103 \fIfmt\fP error message format
 104 .br
 105 \fI...\fP arguments to error message format
 106 .RE
 107 .PP
 108
 109 .SS "void hx509_set_error_stringv (hx509_context context, int flags, int code, const char * fmt, va_list ap)"
 110 .PP
 111 Add an error message to the hx509 context.
 112 .PP
 113 \fBParameters:\fP
 114 .RS 4
 115 \fIcontext\fP A hx509 context.
 116 .br
 117 \fIflags\fP
 118 .IP "\(bu" 2
 119 HX509_ERROR_APPEND appends the error string to the old messages (code is updated).
 120 .PP
 121 .br
 122 \fIcode\fP error code related to error message
 123 .br
 124 \fIfmt\fP error message format
 125 .br
 126 \fIap\fP arguments to error message format
 127 .RE
 128 .PP
 129