doc/manpages/gnutls_crypto_cipher_register2.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_crypto_cipher_register2" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_crypto_cipher_register2 \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "int gnutls_crypto_cipher_register2(int " priority ", int " version ", const gnutls_crypto_cipher_st * " s ");"
   9 .SH ARGUMENTS
  10 .IP "int priority" 12
  11 is the priority of the cipher interface
  12 .IP "int version" 12
  13 should be set to \fBGNUTLS_CRYPTO_API_VERSION\fP
  14 .IP "const gnutls_crypto_cipher_st * s" 12
  15 is a structure holding new interface's data
  16 .SH "DESCRIPTION"
  17 This function will register a cipher interface to be used by
  18 gnutls. Any interface registered will override the included engine
  19 and by convention kernel implemented interfaces should have
  20 priority of 90. The interface with the lowest priority will be used
  21 by gnutls.
  22
  23 This function should be called before \fBgnutls_global_init()\fP.
  24
  25 For simplicity you can use the convenience
  26 \fBgnutls_crypto_cipher_register()\fP macro.
  27 .SH "RETURNS"
  28 \fBGNUTLS_E_SUCCESS\fP on success, otherwise an error.
  29 .SH "SINCE"
  30 2.6.0
  31 .SH "REPORTING BUGS"
  32 Report bugs to <bug-gnutls@gnu.org>.
  33 GnuTLS home page: http://www.gnu.org/software/gnutls/
  34 General help using GNU software: http://www.gnu.org/gethelp/
  35 .SH COPYRIGHT
  36 Copyright \(co 2008 Free Software Foundation.
  37 .br
  38 Copying and distribution of this file, with or without modification,
  39 are permitted in any medium without royalty provided the copyright
  40 notice and this notice are preserved.
  41 .SH "SEE ALSO"
  42 The full documentation for
  43 .B gnutls
  44 is maintained as a Texinfo manual.  If the
  45 .B info
  46 and
  47 .B gnutls
  48 programs are properly installed at your site, the command
  49 .IP
  50 .B info gnutls
  51 .PP
  52 should give you access to the complete manual.