doc/manpages/gnutls_openpgp_privkey_export.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_openpgp_privkey_export" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_openpgp_privkey_export \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/openpgp.h>
   7 .sp
   8 .BI "int gnutls_openpgp_privkey_export(gnutls_openpgp_privkey_t " key ", gnutls_openpgp_crt_fmt_t " format ", const char * " password ", unsigned int " flags ", void * " output_data ", size_t * " output_data_size ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_openpgp_privkey_t key" 12
  11 Holds the key.
  12 .IP "gnutls_openpgp_crt_fmt_t format" 12
  13 One of gnutls_openpgp_crt_fmt_t elements.
  14 .IP "const char * password" 12
  15 the password that will be used to encrypt the key. (unused for now)
  16 .IP "unsigned int flags" 12
  17 zero for future compatibility
  18 .IP "void * output_data" 12
  19 will contain the key base64 encoded or raw
  20 .IP "size_t * output_data_size" 12
  21 holds the size of output_data (and will be
  22 replaced by the actual size of parameters)
  23 .SH "DESCRIPTION"
  24 This function will convert the given key to RAW or Base64 format.
  25 If the buffer provided is not long enough to hold the output, then
  26 GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
  27 .SH "RETURNS"
  28 \fBGNUTLS_E_SUCCESS\fP on success, or an error code.
  29 .SH "SINCE"
  30 2.4.0
  31 .SH "REPORTING BUGS"
  32 Report bugs to <bug-gnutls@gnu.org>.
  33 GnuTLS home page: http://www.gnu.org/software/gnutls/
  34 General help using GNU software: http://www.gnu.org/gethelp/
  35 .SH COPYRIGHT
  36 Copyright \(co 2008 Free Software Foundation.
  37 .br
  38 Copying and distribution of this file, with or without modification,
  39 are permitted in any medium without royalty provided the copyright
  40 notice and this notice are preserved.
  41 .SH "SEE ALSO"
  42 The full documentation for
  43 .B gnutls
  44 is maintained as a Texinfo manual.  If the
  45 .B info
  46 and
  47 .B gnutls
  48 programs are properly installed at your site, the command
  49 .IP
  50 .B info gnutls
  51 .PP
  52 should give you access to the complete manual.