doc/manpages/gnutls_dh_params_import_pkcs3.3

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