doc/manpages/gnutls_error_to_alert.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_error_to_alert" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_error_to_alert \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "int gnutls_error_to_alert(int " err ", int * " level ");"
   9 .SH ARGUMENTS
  10 .IP "int err" 12
  11 is a negative integer
  12 .IP "int * level" 12
  13 the alert level will be stored there
  14 .SH "DESCRIPTION"
  15 Get an alert depending on the error code returned by a gnutls
  16 function.  All alerts sent by this function should be considered
  17 fatal.  The only exception is when \fIerr\fP is \fBGNUTLS_E_REHANDSHAKE\fP,
  18 where a warning alert should be sent to the peer indicating that no
  19 renegotiation will be performed.
  20
  21 If there is no mapping to a valid alert the alert to indicate
  22 internal error is returned.
  23 .SH "RETURNS"
  24 the alert code to use for a particular error code.
  25 .SH "REPORTING BUGS"
  26 Report bugs to <bug-gnutls@gnu.org>.
  27 GnuTLS home page: http://www.gnu.org/software/gnutls/
  28 General help using GNU software: http://www.gnu.org/gethelp/
  29 .SH COPYRIGHT
  30 Copyright \(co 2008 Free Software Foundation.
  31 .br
  32 Copying and distribution of this file, with or without modification,
  33 are permitted in any medium without royalty provided the copyright
  34 notice and this notice are preserved.
  35 .SH "SEE ALSO"
  36 The full documentation for
  37 .B gnutls
  38 is maintained as a Texinfo manual.  If the
  39 .B info
  40 and
  41 .B gnutls
  42 programs are properly installed at your site, the command
  43 .IP
  44 .B info gnutls
  45 .PP
  46 should give you access to the complete manual.