doc/manpages/gnutls_alert_send_appropriate.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_alert_send_appropriate" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_alert_send_appropriate \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "int gnutls_alert_send_appropriate(gnutls_session_t " session ", int " err ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_session_t session" 12
  11 is a \fBgnutls_session_t\fP structure.
  12 .IP "int err" 12
  13 is an integer
  14 .SH "DESCRIPTION"
  15 Sends an alert to the peer depending on the error code returned by
  16 a gnutls function. This function will call \fBgnutls_error_to_alert()\fP
  17 to determine the appropriate alert to send.
  18
  19 This function may also return \fBGNUTLS_E_AGAIN\fP, or
  20 \fBGNUTLS_E_INTERRUPTED\fP.
  21
  22 If the return value is \fBGNUTLS_E_INVALID_REQUEST\fP, then no alert has
  23 been sent to the peer.
  24 .SH "RETURNS"
  25 On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise
  26 an error code is returned.
  27 .SH "REPORTING BUGS"
  28 Report bugs to <bug-gnutls@gnu.org>.
  29 GnuTLS home page: http://www.gnu.org/software/gnutls/
  30 General help using GNU software: http://www.gnu.org/gethelp/
  31 .SH COPYRIGHT
  32 Copyright \(co 2008 Free Software Foundation.
  33 .br
  34 Copying and distribution of this file, with or without modification,
  35 are permitted in any medium without royalty provided the copyright
  36 notice and this notice are preserved.
  37 .SH "SEE ALSO"
  38 The full documentation for
  39 .B gnutls
  40 is maintained as a Texinfo manual.  If the
  41 .B info
  42 and
  43 .B gnutls
  44 programs are properly installed at your site, the command
  45 .IP
  46 .B info gnutls
  47 .PP
  48 should give you access to the complete manual.