doc/manpages/gnutls_init.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_init" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_init \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "int gnutls_init(gnutls_session_t * " session ", gnutls_connection_end_t " con_end ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_session_t * session" 12
  11 is a pointer to a \fBgnutls_session_t\fP structure.
  12 .IP "gnutls_connection_end_t con_end" 12
  13 indicate if this session is to be used for server or client.
  14 .SH "DESCRIPTION"
  15 This function initializes the current session to null. Every
  16 session must be initialized before use, so internal structures can
  17 be allocated.  This function allocates structures which can only
  18 be free'd by calling \fBgnutls_deinit()\fP.  Returns zero on success.
  19
  20 \fIcon_end\fP can be one of \fBGNUTLS_CLIENT\fP and \fBGNUTLS_SERVER\fP.
  21 .SH "RETURNS"
  22 \fBGNUTLS_E_SUCCESS\fP on success, or an error code.
  23 .SH "REPORTING BUGS"
  24 Report bugs to <bug-gnutls@gnu.org>.
  25 GnuTLS home page: http://www.gnu.org/software/gnutls/
  26 General help using GNU software: http://www.gnu.org/gethelp/
  27 .SH COPYRIGHT
  28 Copyright \(co 2008 Free Software Foundation.
  29 .br
  30 Copying and distribution of this file, with or without modification,
  31 are permitted in any medium without royalty provided the copyright
  32 notice and this notice are preserved.
  33 .SH "SEE ALSO"
  34 The full documentation for
  35 .B gnutls
  36 is maintained as a Texinfo manual.  If the
  37 .B info
  38 and
  39 .B gnutls
  40 programs are properly installed at your site, the command
  41 .IP
  42 .B info gnutls
  43 .PP
  44 should give you access to the complete manual.