doc/manpages/gnutls_crypto_single_digest_register2.3

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