Move manpages to man[1357] structure.
[openssl.git] / doc / man3 / DH_new.pod
1 =pod
2
3 =head1 NAME
4
5 DH_new, DH_free - allocate and free DH objects
6
7 =head1 SYNOPSIS
8
9  #include <openssl/dh.h>
10
11  DH* DH_new(void);
12
13  void DH_free(DH *dh);
14
15 =head1 DESCRIPTION
16
17 DH_new() allocates and initializes a B<DH> structure.
18
19 DH_free() frees the B<DH> structure and its components. The values are
20 erased before the memory is returned to the system.
21 If B<dh> is NULL nothing is done.
22
23 =head1 RETURN VALUES
24
25 If the allocation fails, DH_new() returns B<NULL> and sets an error
26 code that can be obtained by L<ERR_get_error(3)>. Otherwise it returns
27 a pointer to the newly allocated structure.
28
29 DH_free() returns no value.
30
31 =head1 SEE ALSO
32
33 L<dh(3)>, L<ERR_get_error(3)>,
34 L<DH_generate_parameters(3)>,
35 L<DH_generate_key(3)>
36
37 =head1 COPYRIGHT
38
39 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
40
41 Licensed under the OpenSSL license (the "License").  You may not use
42 this file except in compliance with the License.  You can obtain a copy
43 in the file LICENSE in the source distribution or at
44 L<https://www.openssl.org/source/license.html>.
45
46 =cut