doc/manpages/gnutls_certificate_set_openpgp_key.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_certificate_set_openpgp_key" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_certificate_set_openpgp_key \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/openpgp.h>
   7 .sp
   8 .BI "int gnutls_certificate_set_openpgp_key(gnutls_certificate_credentials_t " res ", gnutls_openpgp_crt_t " crt ", gnutls_openpgp_privkey_t " pkey ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_certificate_credentials_t res" 12
  11 is a \fBgnutls_certificate_credentials_t\fP structure.
  12 .IP "gnutls_openpgp_crt_t crt" 12
  13 .IP "gnutls_openpgp_privkey_t pkey" 12
  14 is an openpgp private key
  15 .SH "DESCRIPTION"
  16 This function sets a certificate/private key pair in the
  17 gnutls_certificate_credentials_t structure.  This function may be
  18 called more than once (in case multiple keys/certificates exist
  19 for the server).
  20
  21 Note that this function requires that the preferred key ids have
  22 been set and be used. See \fBgnutls_openpgp_crt_set_preferred_key_id()\fP.
  23 Otherwise the master key will be used.
  24 .SH "RETURNS"
  25 On success, \fBGNUTLS_E_SUCCESS\fP (zero) is returned,
  26 otherwise an error code is returned.
  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.