doc/manpages/gnutls_openpgp_privkey_get_pk_algorithm.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_openpgp_privkey_get_pk_algorithm" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_openpgp_privkey_get_pk_algorithm \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/openpgp.h>
   7 .sp
   8 .BI "gnutls_pk_algorithm_t gnutls_openpgp_privkey_get_pk_algorithm(gnutls_openpgp_privkey_t " key ", unsigned int * " bits ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_openpgp_privkey_t key" 12
  11 is an OpenPGP key
  12 .IP "unsigned int * bits" 12
  13 if bits is non null it will hold the size of the parameters' in bits
  14 .SH "DESCRIPTION"
  15 This function will return the public key algorithm of an OpenPGP
  16 certificate.
  17
  18 If bits is non null, it should have enough size to hold the parameters
  19 size in bits. For RSA the bits returned is the modulus.
  20 For DSA the bits returned are of the public exponent.
  21 .SH "RETURNS"
  22 a member of the \fBgnutls_pk_algorithm_t\fP enumeration on
  23 success, or a negative value on error.
  24 .SH "SINCE"
  25 2.4.0
  26 .SH "REPORTING BUGS"
  27 Report bugs to <bug-gnutls@gnu.org>.
  28 GnuTLS home page: http://www.gnu.org/software/gnutls/
  29 General help using GNU software: http://www.gnu.org/gethelp/
  30 .SH COPYRIGHT
  31 Copyright \(co 2008 Free Software Foundation.
  32 .br
  33 Copying and distribution of this file, with or without modification,
  34 are permitted in any medium without royalty provided the copyright
  35 notice and this notice are preserved.
  36 .SH "SEE ALSO"
  37 The full documentation for
  38 .B gnutls
  39 is maintained as a Texinfo manual.  If the
  40 .B info
  41 and
  42 .B gnutls
  43 programs are properly installed at your site, the command
  44 .IP
  45 .B info gnutls
  46 .PP
  47 should give you access to the complete manual.