doc/manpages/gnutls_dh_params_export_pkcs3.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_dh_params_export_pkcs3" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_dh_params_export_pkcs3 \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "int gnutls_dh_params_export_pkcs3(gnutls_dh_params_t " params ", gnutls_x509_crt_fmt_t " format ", unsigned char * " params_data ", size_t * " params_data_size ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_dh_params_t params" 12
  11 Holds the DH parameters
  12 .IP "gnutls_x509_crt_fmt_t format" 12
  13 the format of output params. One of PEM or DER.
  14 .IP "unsigned char * params_data" 12
  15 will contain a PKCS3 DHParams structure PEM or DER encoded
  16 .IP "size_t * params_data_size" 12
  17 holds the size of params_data (and will be replaced by the actual size of parameters)
  18 .SH "DESCRIPTION"
  19 This function will export the given dh parameters to a PKCS3
  20 DHParams structure. This is the format generated by "openssl dhparam" tool.
  21 If the buffer provided is not long enough to hold the output, then
  22 GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
  23
  24 If the structure is PEM encoded, it will have a header
  25 of "BEGIN DH PARAMETERS".
  26 .SH "RETURNS"
  27 On success, \fBGNUTLS_E_SUCCESS\fP (zero) is returned,
  28 otherwise an error code is returned.
  29 .SH "REPORTING BUGS"
  30 Report bugs to <bug-gnutls@gnu.org>.
  31 GnuTLS home page: http://www.gnu.org/software/gnutls/
  32 General help using GNU software: http://www.gnu.org/gethelp/
  33 .SH COPYRIGHT
  34 Copyright \(co 2008 Free Software Foundation.
  35 .br
  36 Copying and distribution of this file, with or without modification,
  37 are permitted in any medium without royalty provided the copyright
  38 notice and this notice are preserved.
  39 .SH "SEE ALSO"
  40 The full documentation for
  41 .B gnutls
  42 is maintained as a Texinfo manual.  If the
  43 .B info
  44 and
  45 .B gnutls
  46 programs are properly installed at your site, the command
  47 .IP
  48 .B info gnutls
  49 .PP
  50 should give you access to the complete manual.