doc/manpages/gnutls_crypto_single_mac_register2.3

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