doc/manpages/gnutls_openpgp_crt_get_subkey_pk_algorithm.3

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