doc/manpages/gnutls_cipher_init.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_cipher_init" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_cipher_init \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "int gnutls_cipher_init(gnutls_cipher_hd_t * " handle ", gnutls_cipher_algorithm_t " cipher ", const gnutls_datum_t * " key ", const gnutls_datum_t * " iv ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_cipher_hd_t * handle" 12
  11 is a \fBgnutls_cipher_hd_t\fP structure.
  12 .IP "gnutls_cipher_algorithm_t cipher" 12
  13 the encryption algorithm to use
  14 .IP "const gnutls_datum_t * key" 12
  15 The key to be used for encryption
  16 .IP "const gnutls_datum_t * iv" 12
  17 The IV to use (if not applicable set NULL)
  18 .SH "DESCRIPTION"
  19 This function will initialize an context that can be used for
  20 encryption/decryption of data. This will effectively use the
  21 current crypto backend in use by gnutls or the cryptographic
  22 accelerator in use.
  23 .SH "RETURNS"
  24 Zero or a negative value on error.
  25 .SH "SINCE"
  26 2.10.0
  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.