doc/manpages/gnutls_pubkey_get_preferred_hash_algorithm.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_pubkey_get_preferred_hash_algorithm" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_pubkey_get_preferred_hash_algorithm \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "int gnutls_pubkey_get_preferred_hash_algorithm(gnutls_pubkey_t " key ", gnutls_digest_algorithm_t *                                             " hash ", unsigned int * " mand ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_pubkey_t key" 12
  11 Holds the certificate
  12 .IP "gnutls_digest_algorithm_t *                                             hash" 12
  13 The result of the call with the hash algorithm used for signature
  14 .IP "unsigned int * mand" 12
  15 If non zero it means that the algorithm MUST use this hash. May be NULL.
  16 .SH "DESCRIPTION"
  17 This function will read the certifcate and return the appropriate digest
  18 algorithm to use for signing with this certificate. Some certificates (i.e.
  19 DSA might not be able to sign without the preferred algorithm).
  20 .SH "RETURNS"
  21 the 0 if the hash algorithm is found. A negative value is
  22 returned on error.
  23 .SH "SINCE"
  24 2.11.0
  25 .SH "REPORTING BUGS"
  26 Report bugs to <bug-gnutls@gnu.org>.
  27 GnuTLS home page: http://www.gnu.org/software/gnutls/
  28 General help using GNU software: http://www.gnu.org/gethelp/
  29 .SH COPYRIGHT
  30 Copyright \(co 2008 Free Software Foundation.
  31 .br
  32 Copying and distribution of this file, with or without modification,
  33 are permitted in any medium without royalty provided the copyright
  34 notice and this notice are preserved.
  35 .SH "SEE ALSO"
  36 The full documentation for
  37 .B gnutls
  38 is maintained as a Texinfo manual.  If the
  39 .B info
  40 and
  41 .B gnutls
  42 programs are properly installed at your site, the command
  43 .IP
  44 .B info gnutls
  45 .PP
  46 should give you access to the complete manual.