doc/manpages/gnutls_error_is_fatal.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_error_is_fatal" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_error_is_fatal \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "int gnutls_error_is_fatal(int " error ");"
   9 .SH ARGUMENTS
  10 .IP "int error" 12
  11 is a GnuTLS error code, a negative value
  12 .SH "DESCRIPTION"
  13 If a GnuTLS function returns a negative value you may feed that
  14 value to this function to see if the error condition is fatal.
  15
  16 Note that you may want to check the error code manually, since some
  17 non\-fatal errors to the protocol may be fatal for you program.
  18
  19 This function is only useful if you are dealing with errors from
  20 the record layer or the handshake layer.
  21 .SH "RETURNS"
  22 1 if the error code is fatal, for positive \fIerror\fP values,
  23 0 is returned.  For unknown \fIerror\fP values, \-1 is returned.
  24 .SH "REPORTING BUGS"
  25 Report bugs to <bug-gnutls@gnu.org>.
  26 GnuTLS home page: http://www.gnu.org/software/gnutls/
  27 General help using GNU software: http://www.gnu.org/gethelp/
  28 .SH COPYRIGHT
  29 Copyright \(co 2008 Free Software Foundation.
  30 .br
  31 Copying and distribution of this file, with or without modification,
  32 are permitted in any medium without royalty provided the copyright
  33 notice and this notice are preserved.
  34 .SH "SEE ALSO"
  35 The full documentation for
  36 .B gnutls
  37 is maintained as a Texinfo manual.  If the
  38 .B info
  39 and
  40 .B gnutls
  41 programs are properly installed at your site, the command
  42 .IP
  43 .B info gnutls
  44 .PP
  45 should give you access to the complete manual.