doc/manpages/gnutls_alert_send.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_alert_send" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_alert_send \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "int gnutls_alert_send(gnutls_session_t " session ", gnutls_alert_level_t " level ", gnutls_alert_description_t " desc ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_session_t session" 12
  11 is a \fBgnutls_session_t\fP structure.
  12 .IP "gnutls_alert_level_t level" 12
  13 is the level of the alert
  14 .IP "gnutls_alert_description_t desc" 12
  15 is the alert description
  16 .SH "DESCRIPTION"
  17 This function will send an alert to the peer in order to inform
  18 him of something important (eg. his Certificate could not be verified).
  19 If the alert level is Fatal then the peer is expected to close the
  20 connection, otherwise he may ignore the alert and continue.
  21
  22 The error code of the underlying record send function will be
  23 returned, so you may also receive \fBGNUTLS_E_INTERRUPTED\fP or
  24 \fBGNUTLS_E_AGAIN\fP as well.
  25 .SH "RETURNS"
  26 On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise
  27 an error code is returned.
  28 .SH "REPORTING BUGS"
  29 Report bugs to <bug-gnutls@gnu.org>.
  30 GnuTLS home page: http://www.gnu.org/software/gnutls/
  31 General help using GNU software: http://www.gnu.org/gethelp/
  32 .SH COPYRIGHT
  33 Copyright \(co 2008 Free Software Foundation.
  34 .br
  35 Copying and distribution of this file, with or without modification,
  36 are permitted in any medium without royalty provided the copyright
  37 notice and this notice are preserved.
  38 .SH "SEE ALSO"
  39 The full documentation for
  40 .B gnutls
  41 is maintained as a Texinfo manual.  If the
  42 .B info
  43 and
  44 .B gnutls
  45 programs are properly installed at your site, the command
  46 .IP
  47 .B info gnutls
  48 .PP
  49 should give you access to the complete manual.