Certificate Management Protocol (CMP, RFC 4210) extension to OpenSSL
[openssl.git] / doc / man3 / d2i_DHparams.pod
1 =pod
2
3 =head1 NAME
4
5 d2i_DHparams, i2d_DHparams - PKCS#3 DH parameter functions
6
7 =head1 SYNOPSIS
8
9  #include <openssl/dh.h>
10
11  DH *d2i_DHparams(DH **a, unsigned char **pp, long length);
12  int i2d_DHparams(DH *a, unsigned char **pp);
13
14 =head1 DESCRIPTION
15
16 These functions decode and encode PKCS#3 DH parameters using the
17 DHparameter structure described in PKCS#3.
18
19 Otherwise these behave in a similar way to d2i_X509() and i2d_X509()
20 described in the L<d2i_X509(3)> manual page.
21
22 =head1 RETURN VALUES
23
24 d2i_DHparams() returns a valid B<DH> structure or NULL if an error occurred.
25
26 i2d_DHparams() returns the length of encoded data on success or a value which
27 is less than or equal to 0 on error.
28
29 =head1 SEE ALSO
30
31 L<d2i_X509(3)>
32
33 =head1 COPYRIGHT
34
35 Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
36
37 Licensed under the Apache License 2.0 (the "License").  You may not use
38 this file except in compliance with the License.  You can obtain a copy
39 in the file LICENSE in the source distribution or at
40 L<https://www.openssl.org/source/license.html>.
41
42 =cut