doc/manpages/gnutls_openpgp_crt_get_auth_subkey.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_openpgp_crt_get_auth_subkey" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_openpgp_crt_get_auth_subkey \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/openpgp.h>
   7 .sp
   8 .BI "int gnutls_openpgp_crt_get_auth_subkey(gnutls_openpgp_crt_t " crt ", gnutls_openpgp_keyid_t " keyid ", unsigned int " flag ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_openpgp_crt_t crt" 12
  11 the structure that contains the OpenPGP public key.
  12 .IP "gnutls_openpgp_keyid_t keyid" 12
  13 the struct to save the keyid.
  14 .IP "unsigned int flag" 12
  15 Non zero indicates that a valid subkey is always returned.
  16 .SH "DESCRIPTION"
  17 Returns the 64\-bit keyID of the first valid OpenPGP subkey marked
  18 for authentication.  If flag is non zero and no authentication
  19 subkey exists, then a valid subkey will be returned even if it is
  20 not marked for authentication.
  21 Returns the 64\-bit keyID of the first valid OpenPGP subkey marked
  22 for authentication.  If flag is non zero and no authentication
  23 subkey exists, then a valid subkey will be returned even if it is
  24 not marked for authentication.
  25 .SH "RETURNS"
  26 \fBGNUTLS_E_SUCCESS\fP on success, or an error code.
  27 .SH "REPORTING BUGS"
  28 Report bugs to <bug-gnutls@gnu.org>.
  29 GnuTLS home page: http://www.gnu.org/software/gnutls/
  30 General help using GNU software: http://www.gnu.org/gethelp/
  31 .SH COPYRIGHT
  32 Copyright \(co 2008 Free Software Foundation.
  33 .br
  34 Copying and distribution of this file, with or without modification,
  35 are permitted in any medium without royalty provided the copyright
  36 notice and this notice are preserved.
  37 .SH "SEE ALSO"
  38 The full documentation for
  39 .B gnutls
  40 is maintained as a Texinfo manual.  If the
  41 .B info
  42 and
  43 .B gnutls
  44 programs are properly installed at your site, the command
  45 .IP
  46 .B info gnutls
  47 .PP
  48 should give you access to the complete manual.