doc/manpages/gnutls_pkcs7_export.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_pkcs7_export" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_pkcs7_export \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/x509.h>
   7 .sp
   8 .BI "int gnutls_pkcs7_export(gnutls_pkcs7_t " pkcs7 ", gnutls_x509_crt_fmt_t " format ", void * " output_data ", size_t * " output_data_size ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_pkcs7_t pkcs7" 12
  11 Holds the pkcs7 structure
  12 .IP "gnutls_x509_crt_fmt_t format" 12
  13 the format of output params. One of PEM or DER.
  14 .IP "void * output_data" 12
  15 will contain a structure PEM or DER encoded
  16 .IP "size_t * output_data_size" 12
  17 holds the size of output_data (and will be
  18 replaced by the actual size of parameters)
  19 .SH "DESCRIPTION"
  20 This function will export the pkcs7 structure to DER or PEM format.
  21
  22 If the buffer provided is not long enough to hold the output, then
  23 *\fIoutput_data_size\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP
  24 will be returned.
  25
  26 If the structure is PEM encoded, it will have a header
  27 of "BEGIN PKCS7".
  28 .SH "RETURNS"
  29 On success, \fBGNUTLS_E_SUCCESS\fP is returned, otherwise a
  30 negative error value.
  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.